README.md 1.9 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
---

Zach Knox's avatar
Zach Knox committed
19
20
To get started, make sure you have Meteor installed on your system.

21
On macOS and Linux, this is as simple as typing `curl https://install.meteor.com/ | sh`
Zach Knox's avatar
Zach Knox committed
22
into your terminal. On Windows, you can download the installer [here](https://install.meteor.com/windows).
23

Zach Knox's avatar
Zach Knox committed
24
25
26
27
28
29
Once you have meteor installed on your system, run the `meteor` command inside of the
`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
developing as meteor has live updating capabilities.

TODO
30
31
32
---

- Grab weather data from a source/sources
Zach Knox's avatar
Zach Knox committed
33
- Put data in a database in order to cache it for users (and to not exceed API call limits)
34
35
36
- Show data in a nice way
- Create a beautiful frontend to view this information
- Optimize interface for mobile
37
38
39
40
41

---

### 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)