diff --git a/README.md b/README.md index 350b94a..df13a90 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,13 @@ Visit https://weatherscan.app/?long_island for a demo ## Running locally 1. Download & Install [node.js LTS](https://nodejs.org/en/) -2. In terminal, run `npm install --production` in the root folder of this project. This will install any dependencies. -3. In terminal, run `npm start` in the root folder of this project. This will start a local web server. -4. Follow the link in the console output. +2. Get weather.com and mapbox.com API keys. +3. Navigate to `/webroot/js` and create `secrets.js`. +4. Open `secrets.js` and type `var api_key = 'YOUR_API_KEY'`. Replace YOUR_API_KEY with the weather.com API key. +5. On a new line, type `var map_key = 'YOUR_API_KEY'`. Replace YOUR_API_KEY with the mapbox.com API key. +6. In terminal, run `npm install --production` in the root folder of this project. This will install any dependencies. +7. In terminal, run `npm start` in the root folder of this project. This will start a local web server. +8. Follow the link in the console output. ## Development This project uses gulp to compile SASS to CSS.