Algojammer

(โ˜… 2,900)

An experimental code editor for writing algorithms

  • .gitignore
  • algojammer.py
  • canvas.html
  • drawing.py
  • execution.py
  • LICENSE
  • README.md
  • state.py
  • state_boxes.py

๐Ÿš€ Installation Guide

1. Get the code
git clone https://github.com/ChrisKnott/Algojammer

Downloads the entire project code from GitHub to your computer.

cd Algojammer

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Python 3 Python is required to use pip.
pip3 install eel

Installs the package published on PyPI directly โ€” no need to clone the source.

โœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -f web/lib/ace/snippets/dockerfile.js -t algojammer .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 algojammer

Runs the built image as an actual container.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip3 install eel

Installs the package published on PyPI directly โ€” no need to clone the source.

โœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation