Development

Each project has its own development setup. This page covers the general workflow.

Cloning a Project

git clone https://github.com/th30d4y/<project-name>.git
cd <project-name>

Use a virtual environment:

python3 -m venv venv
source venv/bin/activate       # Windows: venv\Scripts\activate
pip install -r requirements.txt

For ExecuTrace specifically, install in editable mode to reflect source changes immediately:

pip install -e .

Install dependencies:

pnpm install   # or: npm install

Start the development server:

pnpm run dev   # or: npm run dev

OpenLearnX requires running multiple services. Use separate terminals:

Or run the full stack with Docker:

docker compose up --build

npm run check

See each project’s repository for test instructions. Not all projects have automated test suites documented.