README.md 2.28 KB
Newer Older
1
Weather
Zach Knox's avatar
Zach Knox committed
2
3
4
5
============

This project aims to show the weather around Mason in a beautiful way.

6
7
8
9
On Contributing
---

Weather welcomes all the help it can get. Even if you don't feel like you can be helpful the more technical aspects, we definitely need designers, technical writers, and testers.
Zach Knox's avatar
Zach Knox committed
10
There are many things that can be done with this project (see the issues page and the TODOs below), but sometimes it's the small things that count, so don't be afraid of contributing just a small spelling mistake.
11
12
13
14
15
16
17
18

If you want to get involved, join us in #weather on [our slack team](https://srct.slack.com/). If you need help at all please contact a SRCT member. We want people to contribute, so if you are struggling, or just want to learn we are more than willing to help.

Please visit the [SRCT Wiki](http://wiki.srct.gmu.edu/) for more information on this and other SRCT projects, along with other helpful links and tutorials.

Setup
---

19
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:
Zach Knox's avatar
Zach Knox committed
20

David Haynes's avatar
David Haynes committed
21
    `curl https://install.meteor.com/ | sh`
22

David Haynes's avatar
David Haynes committed
23
    On Windows, you can download the installer [here](https://install.meteor.com/windows).
24

Zac Wood's avatar
Zac Wood committed
25
26
27
2. To install the project's requirements, run `meteor npm install` in your terminal.

3. You will need to provide an API to weather so that the app will actually grab weather data. Sign up for a Dark Sky API Key [here](https://darksky.net/dev/).
28
29

    Once you have your API Key, navigate to the `weather/` directory and run in your terminal `export DARKSKY_API_KEY=` followed by your API Key to provide your key to the app.
30

Zac Wood's avatar
Zac Wood committed
31
4. Navigate to the `weather/` directory and run in your terminal:
32

David Haynes's avatar
David Haynes committed
33
    `meteor`
34

David Haynes's avatar
David Haynes committed
35
    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.
Zach Knox's avatar
Zach Knox committed
36
37

TODO
38
39
40
---

- Grab weather data from a source/sources
Zach Knox's avatar
Zach Knox committed
41
- Put data in a database in order to cache it for users (and to not exceed API call limits)
42
43
44
- Show data in a nice way
- Create a beautiful frontend to view this information
- Optimize interface for mobile
45
46
47
48

---

### Credit where due:
49
[Rain Cloud](https://thenounproject.com/search/?q=Rain+cloud&i=6023) icon by Thomas Le Bas from [the Noun Project](https://thenounproject.com)