diff --git a/README.md b/README.md index 084898ffa95be1958deb158e0ac83fc886abbe7b..ee4e3ebca31df46aba42feb8efc6cd9a02321996 100644 --- a/README.md +++ b/README.md @@ -39,12 +39,10 @@ If you want to work on BrainBox's code, you'll need a local installation: 1. install and start `mongo` database 2. clone the repo and `cd` to the brainbox directory -3. `mkdir public/data` 4. [create a new OAuth application](https://github.com/settings/applications/new) for your local brainbox url (http://localhost:3000 by default) 5. paste the keys into the github-keys.json.example file, and drop the .example 6. drop the `.example` from `blacklist.json.example` 7. drop the `.example` from `whitelist.json.example` 8. `npm install` 9. `npm start` -10. To lint your files use `npm test`, you can use `xo --fix` to fix common mistakes, before committing, -to do that install `xo` globally using `npm i -g xo` +10. To lint your files use `npm test`, and you can use `node_modules/.bin/xo --fix ` to fix common mistakes before committing diff --git a/public/data/.gitkeep b/public/data/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/start.sh b/start.sh index 33ef6a151012cb4876c1285bf8ec498258e0822c..ca73d87770af8ed7ab5c9dc3862e0b65dbdcc1f1 100644 --- a/start.sh +++ b/start.sh @@ -1,7 +1,5 @@ #!/bin/bash cd /brainbox -mkdir -p public -mkdir -p public/data npm install node ./bin/www