Skip to content

Feature Request: Added documentation for installation of graphicsmagick #455

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
Ashu463 wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Feature Request: Added documentation for installation of graphicsmagick #455

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
35 changes: 26 additions & 9 deletions Installing-Oppia-(Linux;-Python-3).md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
## Table of Contents

* [Install prerequisites](#install-prerequisites)
* [Clone Oppia](#clone-oppia)
* [Setup a virtual environment](#setup-a-virtual-environment)
* [Running Oppia on a development server](#running-oppia-on-a-development-server)
* [Tips and tricks](#tips-and-tricks)
* [Notes on installation on Arch Linux systems](#notes-on-installation-on-arch-linux-systems)
* [Changes to installation prerequisites](#changes-to-installation-prerequisites)
* [Changes to the virtual environment setup](#changes-to-the-virtual-environment-setup)
- [Table of Contents](#table-of-contents)
Copy link
Member

@U8NWXD U8NWXD May 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We exclude the table of contents entry from the table of contents

- [Install prerequisites](#install-prerequisites)
- [Clone Oppia](#clone-oppia)
- [Setup a virtual environment](#setup-a-virtual-environment)
- [Running Oppia on a development server](#running-oppia-on-a-development-server)
- [Tips and tricks](#tips-and-tricks)
- [Notes on installation on Arch Linux systems](#notes-on-installation-on-arch-linux-systems)
- [Changes to installation prerequisites](#changes-to-installation-prerequisites)
- [Changes to the virtual environment setup](#changes-to-the-virtual-environment-setup)

**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).

Expand All @@ -33,7 +34,23 @@ bash scripts/install_prerequisites.sh

2. Verify that Java version 11+ is installed. You can use the command `java -version` to do this. (If you need to change the default binary for the `java` command on your machine, use `sudo update-alternatives --config java`.)

3. Install Chrome from [Google's website](https://www.google.com/chrome). You'll need this to run tests.
3. Install GraphicsMagick to enable local image compression and ensure tests run successfully. Follow the appropriate steps below based on your operating system:
- For Ubuntu/Debian systems:
```
sudo apt-get update
sudo apt-get install graphicsmagick
```
Comment on lines +37 to +42
Copy link
Member

@U8NWXD U8NWXD May 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why not just add graphicsmagick to the packages installed in step 1 and to scripts/install_prerequisites.sh? that seems simpler

- For MacOS:
```
brew install graphicsmagick
```
Comment on lines +43 to +46
Copy link
Member

@U8NWXD U8NWXD May 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The macOS installation instructions should go in our separate macOS installation guide

After installation, verify that GraphicsMagick is correctly installed by running:
```
gm version
```
Comment on lines +47 to +50
Copy link
Member

@U8NWXD U8NWXD May 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you can skip this, as we don't confirm installation of any of our other prerequisites. Dropping this will also let you more easily fold this change into step 1

You should see version information printed in the terminal.

4. Install Chrome from [Google's website](https://www.google.com/chrome). You'll need this to run tests.


## Clone Oppia
Expand Down