Installing Oppia - U8NWXD/oppia-wiki GitHub Wiki

If you are looking for more elaborate instructions on how to get started with Oppia, go to setting things up.

Note that throughout our wiki, we use the following notations:

  • $ represents a command prompt that is not root. For example, if we want you to type the command python into your terminal, you'll see $ python. This distinguishes commands (which are prefixed with $) from output from those commands (whose lines are not prefixed with $).
  • # represents a root command prompt. For example, # apt-get install python means to run apt-get install python as root (e.g. using sudo).
  • ... indicates where we've omitted content for the sake of brevity.

To install the Python 3 version of Oppia, follow these instructions:

If you run into any problems during installation, please read these notes and the Troubleshooting page.

Take a look at our guide for getting started with some common code editors.

Warning: You should always edit Oppia code on your local machine. Do not use web-based editors like github.dev or the editor on github.com. These web-based editors won't run the automated checks that run on your local machine. Pushing without these checks just means that the tests will fail on your PR.