Skip to main content
This guide walks through setting up careers-engine for local development. By the end of this guide, you’ll have the project cloned, dependencies installed, and be ready to configure your environment.

Prerequisites

Before installing careers-engine, ensure the following tools are available on your system.
careers-engine uses uv for dependency management and virtual environments.

Clone the repository

Clone the repository and enter the project directory.
If you plan to contribute, fork the repository first and clone your fork instead.

Install dependencies

Install all project dependencies.
This command creates a virtual environment (if required) and installs every dependency defined by the project.

Verify the installation

Confirm that the environment has been created successfully.
You should see Python 3.12 or later. You can also verify that the project dependencies were installed correctly.

Project layout

After installation, the repository structure should look similar to:

Next step

The project is now installed. Continue with the configuration guide to configure environment variables, the Discord bot, and the required repositories.

Configuration