/oppia-android

A free, online & offline learning platform to make quality education accessible for all.

Primary LanguageKotlinApache License 2.0Apache-2.0

Oppia Android

CI Lint and Tests Gitter Mailing List Twitter Follow GitHub issues by-label

Oppia is an online learning tool that enables anyone to easily create and share interactive activities (called 'explorations'). These activities simulate a one-on-one conversation with a tutor, making it possible for students to learn by doing while getting feedback.

The Android app is a new, not-yet-released frontend for Oppia that provides access to Oppia's curated numeracy lessons for users who may not have regular access to internet connectivity, and in a way that can be easily shared across multiple members of the same household.

Oppia Android is written using Kotlin and Java, and leverages Bazel, databinding, Dagger 2, and AndroidX. See also:

Installation

Please refer to the installation wiki page for full instructions.

Contributing

The Oppia project is built by the community for the community. We welcome contributions from everyone, especially new contributors.

You can help with Oppia's development in many ways, including coding, instructional design & storytelling, UX research, creating voiceovers, design & art, and documentation.

  • Mobile developers: please see this wiki page for instructions on how to set things up and commit changes.
  • Other developers: see this wiki page for instructions on how to set things up for development on Oppia's frontend or backend.
  • All other contributors: please see our general contributor guidelines.

Development

The Oppia Android codebase is specifically designed to streamline development by utilizing design patterns that reduce the likelihood of making mistakes, and by leveraging powerful libraries and technologies to reduce the amount of code that needs to be written. See the Overview of the Oppia Android codebase wiki page for more specifics on the architecture. A brief list of libraries & technologies that the team makes significant use of:

The team puts special emphasis on writing high-quality, readable, maintainable, and well-tested code.

Support

If you have any feature requests or bug reports, please log them on our issue tracker.

Please report security issues directly to admin@oppia.org.

License

The Oppia Android code is released under the Apache v2 license.

Keeping in touch

We also have public chat rooms on Gitter: https://gitter.im/oppia/oppia-android. Drop by and say hello!