immadisairaj / CodeforcesApp

An android application which uses Codeforces Api.
Apache License 2.0
15 stars 7 forks source link

Codeforces Android App

Watchers Star Gazers Forks

License Gitter Build Status Open Issues PRs Contributors

Communication

Our chat channel is on gitter here

Development

A native Android app using Java for writing code.

Installing

First time contributors can read CONTRIBUTION.md file for help regarding creating issues and sending pull requests.

Setting up the Android Project

  1. Download the CodeforcesApp project source. You can do this either by forking and cloning the repository (recommended if you plan on pushing changes) or by downloading it as a ZIP file and extracting it.

  2. Open Android Studio, you will see a Welcome to Android window. Under Quick Start, select Import Project (Eclipse ADT, Gradle, etc.)

  3. Navigate to the directory where you saved the CodeforcesApp project, select the root folder of the project (the folder named "CodeforcesApp"), and hit OK. Android Studio should now begin building the project with Gradle.

  4. Once this process is complete and Android Studio opens, check the Console for any build errors.

    • Note: If you receive a Gradle sync error titled, "failed to find ...", you should click on the link below the error message (if available) that says Install missing platform(s) and sync project and allow Android studio to fetch you what is missing.
  5. Once all build errors have been resolved, you should be all set to build the app and test it.

  6. To Build the app, go to Build>Make Project (or alternatively press the Make Project icon in the toolbar).

  7. If the app was built successfully, you can test it by running it on either a real device or an emulated one by going to Run>Run 'app' or pressing the Run icon in the toolbar.

Libraries used and their documentation

API Used

Codeforces API Docs

Built With

Code of Conduct

This project Code of Conduct is under the Contributor Covenant, see the CODE_OF_CONDUCT.md for more details.

License

This project is licensed under the Apache License, see the LICENSE.md for more details.