Commit 7eb4b050 authored by David Haynes's avatar David Haynes
Browse files

Update the README improving the setup section

- tell the user to setup secrets.js
parent 299fad8e
...@@ -16,15 +16,19 @@ Please visit the [SRCT Wiki](http://wiki.srct.gmu.edu/) for more information on ...@@ -16,15 +16,19 @@ Please visit the [SRCT Wiki](http://wiki.srct.gmu.edu/) for more information on
Setup Setup
--- ---
To get started, make sure you have Meteor installed on your system. 1. To get started, make sure you have Meteor installed on your system. On macOS and Linux, this is as simple as typing into your terminal:
On macOS and Linux, this is as simple as typing `curl https://install.meteor.com/ | sh` `curl https://install.meteor.com/ | sh`
into your terminal. On Windows, you can download the installer [here](https://install.meteor.com/windows).
Once you have meteor installed on your system, run the `meteor` command inside of the On Windows, you can download the installer [here](https://install.meteor.com/windows).
`weather/` directory of the project files. This will start a local server for you to
use during development. Note that you will likely not have to restart this server while 2. You will need to provide an API to weather so that the app will actually grab weather data. Navigate to `weather/server/lib/secrets.js.template` and follow the instructions included to setup the API key. Make sure you duplicate that file and name it `secrets.js`.
developing as meteor has live updating capabilities.
3. Once you have meteor installed on your system, navigate to the `weather/` directory and run in your terminal:
`meteor`
This will start a local server for you to use during development. Note that you will likely not have to restart this server while developing as meteor has live updating capabilities.
TODO TODO
--- ---
...@@ -38,4 +42,4 @@ TODO ...@@ -38,4 +42,4 @@ TODO
--- ---
### Credit where due: ### Credit where due:
[Rain Cloud](https://thenounproject.com/search/?q=Rain+cloud&i=6023) icon by Thomas Le Bas from [the Noun Project](https://thenounproject.com) [Rain Cloud](https://thenounproject.com/search/?q=Rain+cloud&i=6023) icon by Thomas Le Bas from [the Noun Project](https://thenounproject.com)
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment