Update installation instructions

Sign in is required now, so make those part of the local dev setup instructions.

Https is default now, explain that.

New recommended node version.

All based on #356 (comment).

Also link to contribution page instead of issues directly.

Author: tordans

CONTRIBUTING.md

@@ -31,13 +31,4 @@ JavaScript error message.
 
 When in doubt, be over-descriptive of the bug and how you discovered it.
 
-## How to login when running locally in development mode
-
-* Start the development server with `yarn start`;
-* After loading the page in your browser, inspect the request made to `social-auth/` and copy the `oauth_token`;
-* In other browser tab, access `https://www.openstreetmap.org/oauth/authorize?oauth_token=<oauth_token>` and give authorization in the OpenStreetMap page that will load;
-* You will be redirected to a blank page that has a `oauth_verifier` in the url. Copy the `oauth_verifier`;
-* Click on the `Sign in` button on your local OSMCha instance, paste the `oauth_verifier` and you will be logged in.
-
-
 -- This doc was inspired from [iD](https://github.com/openstreetmap/iD/blob/master/CONTRIBUTING.md)

README.md

@@ -20,30 +20,38 @@ This repository uses [prettier](https://github.com/prettier/prettier) to keep th
 - Atom users can simply install the [prettier-atom](https://atom.io/packages/prettier-atom) package and use Ctrl+Alt+F to format a file (or format on save if enabled).
 - Visual Studio Code users can Search for Prettier - JavaScript formatter.
 
-## Workflow
+### Prerequisite
+- Make sure your node version is *9.1*.
+- Install `yarn` globally using `brew install yarn`.
+- Install `watchman` globally with `brew install watchman`.
 
-`yarn start`
+### Local development
+1. `yarn start`
+1. Open [https://localhost:3000/?filters={%22date__gte%22%3A[{%22label%22%3A%222017-05-01%22%2C%22value%22%3A%222017-05-01%22}]}](https://localhost:3000/?filters={%22date__gte%22%3A[{%22label%22%3A%222017-05-01%22%2C%22value%22%3A%222017-05-01%22}]})
+  - The app runs with https; Firefox is recommended since it allows self signed certificates.
+  - The staging database only has changesets until mid 2017; without the filter you will not see any changesets.
 
-Runs the app in the development mode.
-Open http://localhost:3000 to view it in the browser.
+*To sign in:*
 
+1. After loading the page in your browser, inspect the request made to `social-auth/` and copy the `oauth_token`;
+1. In other browser tab, access `https://www.openstreetmap.org/oauth/authorize?oauth_token=<oauth_token>` and give authorization in the OpenStreetMap page that will load;
+1. You will be redirected to a blank page that has a `oauth_verifier` in the url. Copy the `oauth_verifier`;
+1. Click on the `Sign in` button on your local OSMCha instance, paste the `oauth_verifier` and you will be logged in.
 
-### Prerequisite
-- Make sure your node version is 7.
-- Install `yarn` globally using `brew install yarn`.
-- Install `watchman` globally with `brew install watchman`.
+### Local testing
+Test the application before commiting any changes. If you encounter any error make sure you have `watchman` installed. [Installation Guide](https://facebook.github.io/watchman/docs/install.html).
 
-### Deploy/Release
+```bash
+yarn test
+```
+
+## Deploy/Release
 - There are three stacks to deploy to
 - `yarn deploy:dev` deploys it to `mapbox.github.io`
 - `yarn deploy:staging` deploys it to `osmcha-django-staging.tilestream.net`
 - `yarn deploy:prod` deploys it to `osmcha.mapbox.com`
 
-1. Test the application before commiting any changes. If you encounter any error make sure you have `watchman` installed. [Installation Guide](https://facebook.github.io/watchman/docs/install.html).
-
-```bash
-yarn test
-```
+1. Run the tests with `yarn test`
 
 2. (optional) before deploy, you might want to increment the version number of application.
     * We use `minor` for all non-drastic changes.
@@ -82,5 +90,7 @@ yarn deploy:<stack>
 * [OSMCha python library](https://github.com/willemarcel/osmcha) _(used to analyse the OSM changesets)_
 * [osm-compare](https://github.com/mapbox/osm-compare) _(used to analyse the OSM features)_
 
+## Issues and feature requests
+
 If you have any error reports of want to request new features, please
-[report here](https://github.com/mapbox/osmcha-frontend/issues).
+[read our contribution guide to file an issue](CONTRIBUTING.md).