Changed code blocks in README

master
Keith Irwin 2017-05-02 05:57:10 -04:00
parent 3a741c509f
commit 2ffee6d432
No known key found for this signature in database
GPG Key ID: 378933C743E2BBC0
1 changed files with 9 additions and 5 deletions

View File

@ -6,8 +6,12 @@ node.js application to display a sharable map with user's location.
## Installation
On unix-based systems:
```sh
$ git clone https://github.com/Tracman-org/Server.git && (cd Server && exec npm install)
git clone https://github.com/Tracman-org/Server.git &&\
mv Server tracman-server && cd tracman-server &&\
exec npm install
```
You will need to set up a configuration file at `config/env/env.js`. Use `config/env/sample.js` for an example. You can get API keys at the [google developer's console](https://console.developers.google.com/apis/credentials). You will need to set up approved hosts and auth callbacks. There is more information in [their documentation](https://support.google.com/googleapi/answer/6158857?hl=en).
@ -15,8 +19,8 @@ You will need to set up a configuration file at `config/env/env.js`. Use `confi
A good method is to simply copy the sample configuration and point `config/env/env.js` to the new version:
```sh
$ cp config/env/sample.js config/env/my-config.js
$ printf "'use strict';\n\nmodule.exports = require('./my-config.js');" > config/env/env.js
cp config/env/sample.js config/env/my-config.js
printf "'use strict';\n\nmodule.exports = require('./my-config.js');" > config/env/env.js
```
Then edit `config/env/my-config.js` to match your local environment.
@ -27,13 +31,13 @@ Then edit `config/env/my-config.js` to match your local environment.
Run Tracman with npm:
```sh
$ npm run minify && npm start
npm run minify && npm start
```
...or with [nodemon](https://nodemon.io/):
```sh
$ npm run nodemon
npm run nodemon
```
Nodemon will automatically minify files and restart the app when you make changes. Check out the `nodemon.json` configuration.