Update README.md
removed long island location from demo cause it really wasn't a good location for demo. added screenshots/preview and some other things
This commit is contained in:
parent
206a6f0e81
commit
c9b0d953c1
18
README.md
18
README.md
|
@ -1,9 +1,12 @@
|
||||||
# Weatherscan Simulator
|
# Weatherscan Simulator
|
||||||
Weatherscan simulation in HTML/JS/CSS
|
[![Join our discord](https://discord.com/api/guilds/901963652649848892/widget.png?style=shield)](https://discord.gg/KqyDsnjFgg)
|
||||||
|
|
||||||
Visit https://weatherscan.tk/?long_island for a demo
|
Weatherscan simulation in PWA (Progressive web application), coded in **HTML/JS/CSS**
|
||||||
|
#### Visit https://weatherscan.tk/?philadelphia for a demo of the PWA
|
||||||
|
|
||||||
## Running locally
|
# Installation
|
||||||
|
|
||||||
|
### Running locally and development
|
||||||
1. Download & Install [node.js LTS](https://nodejs.org/en/)
|
1. Download & Install [node.js LTS](https://nodejs.org/en/)
|
||||||
2. Get weather.com and mapbox.com API keys.
|
2. Get weather.com and mapbox.com API keys.
|
||||||
3. Navigate to `/webroot/js` and create `secrets.js`.
|
3. Navigate to `/webroot/js` and create `secrets.js`.
|
||||||
|
@ -13,5 +16,8 @@ Visit https://weatherscan.tk/?long_island for a demo
|
||||||
7. In terminal, run `npm start` in the root folder of this project. This will start a local web server.
|
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.
|
8. Follow the link in the console output.
|
||||||
|
|
||||||
## Development
|
# Screenshots
|
||||||
Install the simulator like normal.
|
#### Weatherscan simulator in normal mode
|
||||||
|
![image](https://user-images.githubusercontent.com/38764606/163455365-435dfa26-6c9b-4351-96d6-e280a141b1e8.png)
|
||||||
|
#### Weatherscan simulator in severe weather mode
|
||||||
|
![image](https://user-images.githubusercontent.com/38764606/163454458-04d2938f-cfad-4f75-81b7-a95feb3f9d49.png)
|
||||||
|
|
Loading…
Reference in New Issue