Running QuantJourney on Windows

To ensure consistency across all operating systems - Windows, macOS, and Linux -we strongly recommend running QuantJourney via Docker. By leveraging Docker containers, you gain a standardized environment where all files, dependencies, and configurations remain identical, regardless of your system.

For Windows users, our custom run_docker.ps1 script, written specifically in Windows PowerShell, allows you to set up and launch QuantJourney in just 2–3 minutes. This script automates the setup process:

• No manual installations beyond the essentials.

• No complex setups or environment mismatches.

• All containers running with a single command.

With minimal effort, you’ll have QuantJourney fully operational, just like on macOS or Linux.

Here is video on Our YT:

Note: If you’re using macOS or Linux, a similar guide is available at: https://quantjourney.dev/docker/

Requirements:

Ensure the following are installed before starting:

• Python 3.12.8 installed (or older, if you have version newer than 3.12.8 please downgrade), download link: https://www.python.org/downloads/

• Git installed, download link: https://git-scm.com/

• Desktop Docker installed, link: https://www.docker.com/products/docker-desktop/

• MongoDB compass as .msi package, download link: https://www.mongodb.com/try/download/community

• Visual Studio Code installed, download link:

  https://code.visualstudio.com/

---

Join our ✋ Discord Server in just 1 minute: https://discord.gg/87sX9Fhj

Why join?

• Chat directly with me: ask questions, share ideas, or suggest changes to the framework.

• Connect with 500+ traders and investors: discuss strategies, share insights, and level up your game.

---

Step-by-Step Guide:

1. Clone (or download) the QuantJourney repository into your preferred directory.

2. Create a new Python virtual environment in your directory and activate it:

python -m venv <name of your virtual environment> e.g ‘python -m venv my_env’
‘<name of your virtual environment>\Scripts\activate’

after activating your venv, change directory to quantjourney

3. Start your Docker application

4. Find run_docker.ps1 script in main directory on GitHub Repo and execute it:

‘.\run_docker.ps1’

if you haven’t had any errors, you should see:

5. Check, that everything is running:

open docker (app) (if its not opening, restart your computer) - you should see something like this:

Here you should have quantjourney.mongodb running, and quantjourney.code running. The rest containers will run either, but they’re not essential when you start with QuantJourney.

CAUTION: If by any chance all of the containers aren’t running automatically, RUN .\run_docker.ps1’ AGAIN

6. Open VSC (Visual Studio Code):

• press ‘CTRL + SHIFT + X’ (for default settings) and download extension called ‘dev containers’ by microsoft

press ‘F1’ (for default settings) and search for command called ‘Dev Containers: Attach to running Container’, run it

You are good to go! you have to run ‘run_docker.ps1’ script only first time.

Next time go into docker app and turn on containers by hand (running ‘run_docker.ps1’ again would reset the containers and all your work!!)

Happy Trading!

Jakub & Alex