Skip to content

Update installation documentation for GitHub UI clarity and validatio… #526

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Amit-sandhu wants to merge 1 commit into
base: develop
Choose a base branch
from
+6 −4
Open

Update installation documentation for GitHub UI clarity and validatio… #526

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions Installing-Oppia-(Linux;-Python-3).md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@

**Note:** If you just want to create and share explorations, you may be able to use the hosted server at https://www.oppia.org (in which case you don't need to install anything).

*These installation instructions were last tested on 8 January 2024. For more information on issues that may occasionally arise with the installation process, see the [Troubleshooting](https://github.com/oppia/oppia/wiki/Troubleshooting) page or ask in the [GitHub Discussions](https://github.com/oppia/oppia/discussions).*
*These installation instructions were last tested in March 2026. For more information on issues that may occasionally arise with the installation process, see the [Troubleshooting](https://github.com/oppia/oppia/wiki/Troubleshooting) page or ask in the [GitHub Discussions](https://github.com/oppia/oppia/discussions).*

## Install prerequisites

Oppia relies on a number of programs and third-party libraries. Many of these libraries are downloaded automatically for you when you first run the `start.py` script provided with Oppia (see step 1 in the next section). However, there are some things that you will need to do beforehand:

1. Make sure you have curl (used to download third-party libraries), git (which allows you to store the source in version control), unzip (used for unpacking zip files) and openjdk-11-jre (needed for GCP to work):
1. Make sure you have curl (used to download third-party libraries), git (which allows you to store the source in version control), unzip (used for unpacking zip files), and openjdk-11-jre (needed for GCP to work):


```
Expand Down Expand Up @@ -46,13 +46,15 @@ bash scripts/install_prerequisites.sh

4. Next, click the `Fork` button to create your own copy of the repository.

(Note: GitHub's interface may change over time, but the **Fork** button is typically located near the top-right of the repository page.)

![Screenshot with the fork button](images/install/fork.png)

You should now see Oppia under your repositories. It will be marked as forked from `oppia/oppia`.

![Screenshot of repository list with Oppia](images/install/repositoryList.png)

5. Clone the repository to your local computer (replacing the values in `{{}}`):
6. Clone the repository to your local computer (replacing the values in `{{}}`):

```console
$ git clone https://github.com/{{GITHUB USERNAME}}/oppia.git
Expand All @@ -66,7 +68,7 @@ bash scripts/install_prerequisites.sh

Note that you will see slightly different output because the numbers change as Oppia grows.

6. Now your `origin` remote is pointing to your fork (`{{GITHUB USERNAME}}/oppia`). To stay up to date with the main `oppia/oppia` repository, add it as a remote called `upstream`. You'll first need to move into the `oppia` directory that was created by the clone operation.
7. Now your `origin` remote is pointing to your fork (`{{GITHUB USERNAME}}/oppia`). To stay up to date with the main `oppia/oppia` repository, add it as a remote called `upstream`. You'll first need to move into the `oppia` directory that was created by the clone operation.

```console
$ cd oppia
Expand Down