Weatherscan/README.md

22 lines
1.0 KiB
Markdown
Raw Normal View History

2018-09-19 18:49:07 +00:00
# Weatherscan Simulator
Weatherscan simulation in HTML/JS/CSS
2021-08-24 23:10:58 +00:00
Visit https://weatherscan.app/?long_island for a demo
2018-09-19 18:49:07 +00:00
2018-09-19 21:54:04 +00:00
## Running locally
2021-08-24 23:10:58 +00:00
1. Download & Install [node.js LTS](https://nodejs.org/en/)
2021-08-25 01:26:40 +00:00
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.
2018-09-19 21:54:04 +00:00
2018-09-19 18:49:07 +00:00
## Development
This project uses gulp to compile SASS to CSS.
1. Download & Install [node.js LTS](https://nodejs.org/en/)
2. Run `npm install gulp-cli -g`
2018-09-19 22:38:07 +00:00
2. Run `npm install` in the root folder of this project.
2018-09-19 18:49:07 +00:00
3. Run `gulp` or `gulp watch` in the root directory to compile.