README.md 2.46 KB
Newer Older
1 2 3
What's Open
===

Robert Hitt's avatar
Robert Hitt committed
4 5
[![build status](https://git.gmu.edu/srct/whats-open-android/badges/master/build.svg)](https://git.gmu.edu/srct/whats-open-android/commits/master)

6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
Simple Android app that gets data from the [What's Open API](https://whatsopen.gmu.edu/api/) and
displays it in an (ostensibly) pretty way, with some Android-specific bells and whistles.

Contributing
---

What's Open needs all the help it can get. Even if you don't feel
like you can be helpful with the heavily technical aspects,
we definitely need designers and technical writers.

There are many things that can be done with this project (see the "To Do" 
section), but sometimes it's the small things that count, so don't be afraid of 
contributing just for a spelling mistake.

If you need help at all please contact any SRCT member. We want people to
contribute, so if you are struggling, or just want to learn, then we are willing
to help.

Set Up
---

To get started, you'll need the following installed:

* [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
* [Android Studio](https://developer.android.com/studio/index.html)

```bash
git clone https://git.gmu.edu/srct/whats-open-android.git
```

That's about it. From there you can use Android Studio's built in VCS tools,
or continue from the command line. 

Some helpful links for using git:

* [Within Android Studio](http://wii.logdown.com/posts/2013/11/15/android-studio-git-tutorial)
* [General Git reference](http://gitref.org/)

Modifying and Deploying Code
---

With the means of testing the app, you can really start contributing.

If you're new to Android development and don't know where to start, I recommend the 
[Android guides from Codepath](https://guides.codepath.com/android). They have a large 
volume of moderately helpful tutorials on both the Android SDK and some popular libaries. 

If you like spending money, [this is also a good starting point](https://www.amazon.com/Android-Programming-Ranch-Guide-Guides/dp/0321804333), though it pretty much just covers
the Android SDK, ignoring lots of very helpful libraries (which are used often by this project).

To Do
---

Robert Hitt's avatar
Robert Hitt committed
59 60 61 62
* Expand offline functionality
* Make app icon
* Add notifications
* Make a widget
63 64 65 66

## About Mason SRCT

**S**tudent - **R**un **C**omputing and **T**echnology (*SRCT*, pronounced "circuit") is a student organization at George Mason University which enhances student computing at Mason. SRCT establishes and maintains systems which provide specific services for Mason's community.