Local Sky

Explore the docs »

· Report Bug/Request Features ·

Table of Contents

1. Abstract
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License

Abstract

A weather app with the ability to upload your own weather data about your surroundings. Users are able to upload live weather reports to a map, where other users may interact and view their reports. Reports are only active for 2 hours, which helps to keep all information up to date for other users.

(back to top)

Team Members

Ason Yue

Francis Scallatino

Josh O'Halloran

Nick Rucinski

Getting Started

To get a local copy up and running follow these simple example steps.

Installation

1. Get a free API Key at Google
2. Get a free API Key at Pirate Weather
3. Clone the repo

   git clone https://github.com/TULocalSky/localsky.git

4. Enter your API keys in local.properties

   GOOGLE_MAPS_API_KEY=YOURAPIKEYHERE
   PIRATE_WEATHER_API_KEY=YOURAPIKEYHERE

(back to top)

Contributing

How to contribute to the project

0. See Installation
1. Create your Feature Branch (git checkout -b YourName/Feature)
2. Commit your Changes (git commit -m 'Add some AmazingFeature')
3. Push to the Branch (git push origin feature/AmazingFeature)
4. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)