Skip to content

Commit

Permalink
🔀 Merge branch 'feature/markdown-guide' into develop
Browse files Browse the repository at this point in the history
🔀 Merge branch 'feature/markdown-blog' into develop
📝 created README.md for documentation
  • Loading branch information
ohheyitsdave committed Jan 16, 2020
1 parent fcb1da3 commit b2b2e96
Showing 1 changed file with 40 additions and 9 deletions.
49 changes: 40 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,67 @@
# sensor.community-website
# sensor.community website

:sparkles: new shiny website for dust and noise measuring project :point_right: sensor.community

## How to install
### Prerequisites

Node.js (v12.13+)
Yarn
* [Node.js (v11+)](https://nodejs.org/)
* [Yarn (optional)](yarnpkg.com)

## Get started

Install the dependencies...
inside the folder install the dependencies...

```bash
cd sensor.community
npm install | or yarn install
npm install
```

or with yarn

```bash
yarn install
```

...then start [Rollup](https://rollupjs.org):

```bash
npm run dev || yarn dev
npm run dev or sapper dev
```

alternative use yarn
```bash
yarn install
yarn run dev or sapper dev
```

Navigate to [localhost:3000](http://localhost:3000).
You should see your app running. Edit a component file in `src`, save it, and reload the page to see your changes.

By default, the server will only respond to requests from localhost. To allow connections from other computers, edit the `sirv` commands in package.json to include the option `--host 0.0.0.0`.

### Getting started with Svelte & Sapper
Website is based on [Svelte 3](https://svelte.dev) and [Sapper](https://sapper.svelte.dev).
Please consider reading the documentation.

## Deploying to the web
### TODO
## Translation
1. Create locale file

```bash
npx i18next-svelte-scanner -s src -o ./locales/<language>.json
```

```bash
npx i18next-svelte-scanner -s src -o ./locales/fr.json
```
2. Add it to the i18n.js
```javascript
register('fr', () => import('../locales/fr.json'));
```

## Bugs and feedback
The website is in early development, and may have the odd rough edge here and there.

## Deployment
### TODO

Happy coding :tadaraised_hands:

0 comments on commit b2b2e96

Please sign in to comment.