Installation

Here is everything you need to start your first SpeedPy project.

Dependencies & Requirements

You need Git installed to get the codebase and work with your project.

SpeedPy is meant to work under Linux or Mac OS.

If you are using Windows, you'd need to run Linux in WSL.

Please note, that SpeedPy under Windows/WSL is not tested, so you might have to deal with specifics of this setup yourself.

You need to have Docker installed (or Docker Desktop on Mac & Windows).

Generally you won't need to install Python or Node/NPM into your system as everything will be running in Docker.

If your code editor requires Python environment to be setup locally for code completions and such, then please install Python 3.13.9.

Once you have Docker installed the easiest way to get the project up and running is either of these one-liners:

bash -c "$(curl -fsSL https://speedpy.com/install)"

bash -c "$(wget -O - https://speedpy.com/install)"

Running either of these commands will:

ask for the project name
clone the boilerplate from GitHub
create rename speedpy git origin and create a speedpy branch that you can use to update your project to the most recent version of the boilerplate.
initialize the project configuration(docker-compose.yml with random ports, paths to static files, install npm packages, create superuser and store it to local_password.txt for your convenience)
Start the project and open it in the default browser.

Alternatively, you can clone the code manually and initialize the project:

git clone https://github.com/speedpy/speedpy.git myproject
cd myproject
bash init.sh