mcongrove / ForekastMobile

The mobile app for Forekast
11 stars 5 forks source link

Forekast

Forekast Mobile Application

The Forekast mobile application supports iOS and Android, and is built on the Appcelerator platform. The application is coded mostly in JavaScript.

Attribution

Application designed and developed by Matthew Congrove, with contributions by:

This application is not owned or maintained by Forekast. Forekast, the astronaut logo, and data used with permission of Forekast, Inc.

Special thanks to the entire Forekast team for creating an amazing service and letting this app be created.

Contributing

Any feedback, requests, or code changes are absolutely welcome and appreciated.

Feature requests and bug reports can be created as a GitHub Issue.

Code Contributions

Code changes require a bit more effort. To get started, you'll need to download Appcelerator Titanium and follow the Quick Start guide. Titanium is well-documented with API information, guides, and tutorials.

To submit a code change, please fork this repository to your personal GitHub account. After making your changes, submit a pull request. Your changes will be reviewed by one of the project administrators for various checks, including:

Code changes that fail to meet the above standards, or for any other reason at the discretion of the project administrators, will be rejected. We will do our best to work with you to improve your pull request until it's deemed acceptable.

If you're taking on a bug, please comment on the Issue so that work isn't duplicated.

If you'd like to add a completely new feature, please submit an Issue so that we may all discuss the benefits. This is to ensure that you don't waste your time developing a feature we won't implement.

Anyone who submits a few successfully merged pull requests will be added to the contributors list, at the discretion of project administrators.

Developer Notices

To protect private key information, the app/config.json file has been cleansed and renamed to app/config.json.example. Please remove the .example from the file before compiling the application.

You'll also need to install the following modules:

Code Standards

We've included JS Beautifier in this project; it automatically runs each time you compile to keep the code uniform. Please try to learn the coding style already in-use throughout the application.

Documentation of code is required.