Skip to content

Latest commit

 

History

History
71 lines (44 loc) · 4.38 KB

README.md

File metadata and controls

71 lines (44 loc) · 4.38 KB

Oppia Build Status Code Coverage

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 and get feedback.

Oppia is written using Python and AngularJS, and is built on top of Google App Engine.

Installation

Please refer to the developer wiki for full installation instructions. This is just a short summary for developers who would like to contribute:

  1. Create a new, empty folder called opensource/ within your home folder. Navigate to it (cd opensource), then fork and clone the Oppia repo. This will create a new folder named opensource/oppia.

  2. Navigate to opensource/oppia/ and run:

  git checkout develop
  bash scripts/start.sh
  1. To run tests:
  bash scripts/run_tests.sh

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 art, coding, design and documentation.

In addition, if you're making contributions to the codebase, please sign the CLA so that we can accept your contributions.

  • If you're contributing as an individual, use the individual CLA.
  • If your company owns the copyright to your contributions, a company representative should sign the corporate CLA.

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 code is released under the Apache v2 license.

Keeping in touch

We also have a chat room on Gitter: https://gitter.im/oppia