Development Environment¶

Follow the steps below to set up your development environment.

Configure your SSH Key¶

Follow the steps below to configure your SSH key for accessing the repository:

Clone the Repository¶

To clone the repository, run the following command:

git clone git@github.com:cj12-calm-calatheas/code-jam-12.git

This will clone the repository to your local machine using SSH.

Environment Setup¶

To get started with the project, you can either install the devcontainer or follow the manual setup instructions below.

Using the Devcontainer¶

This project includes a devcontainer to automatically set up your development environment, including the all tools and dependencies required for local development.

Prerequisites

Please ensure you have the following prerequisites installed:

Docker must be installed on your system to use the devcontainer.
The Remote Development Extension Pack for Visual Studio Code must be installed to work with devcontainers.

Use WSL on Windows

If you are using Windows, we strongly recommend cloning the repository into the WSL filesystem instead of the Windows filesystem. This significantly improves I/O performance when running the devcontainer.

Configure your SSH Agent¶

The devcontainer will attempt to pick up your SSH key from your ssh-agent when it starts. Follow the guide on sharing git credentials with the devcontainer to ensure your SSH key is available inside the container.

Open the Repository¶

To get started, navigate to the folder where you cloned the repository and run:

code .

This will open the current directory in Visual Studio Code.

Build the Environment¶

Once Visual Studio Code is open, you will see a notification at the bottom right corner of the window asking if you want to open the project in a devcontainer. Select Reopen in Container.

Your development environment will now be set up automatically.

What if I don't see the notification?

You can manually open the devcontainer by pressing F1 to open the command pallette. Type >Dev Containers: Reopen in Container and press Enter to select the command.

Detailed Setup Guides

For more details, refer to the setup guide for your IDE:

Manual Setup¶

Alternatively, you can set up the development environment manually by following the steps below.

Prerequisites

Please ensure you have the following prerequisites installed:

Python 3.13 must be installed on your system.
Node.js must be installed on your system for linting non-Python files.

You can check your Python version with:

python --version

Open the Repository¶

Start by opening the repository in your terminal or command prompt.

cd path/to/your/repository

Set up your Python Environment¶

This project uses uv for dependency management. If you don't have uv installed, you can install it using pip:

python -m pip install uv

To install the dependencies, run:

uv venv --allow-existing && uv sync

This sets up a virtual environment and installs all required packages.

Install Node.js Dependencies¶

For linting non-Python files, we also require some Node.js dependencies. To install them, run:

npm install

Set up Pre-commit Hooks¶

To ensure code quality, this project uses pre-commit hooks. Install them by running:

uv run pre-commit install

This will set up the pre-commit hooks to run automatically on each commit.

Install Playwright¶

This project uses Playwright to simulate user interactions for testing. To install the required dependencies, run the following command:

uv run playwright install --with-deps