> ## Documentation Index
> Fetch the complete documentation index at: https://careers-engine.zenyukti.in/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Install the project locally.

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.

| Requirement | Version       |
| ----------- | ------------- |
| Python      | 3.12 or newer |
| Git         | Latest        |
| uv          | Latest        |

<Info>
  careers-engine uses <a href="https://docs.astral.sh/uv/" target="_blank">uv</a> for dependency management and virtual environments.
</Info>

***

## Clone the repository

Clone the repository and enter the project directory.

```bash theme={null}
git clone https://github.com/ZenYukti/careers-engine.git

cd careers-engine
```

If you plan to contribute, fork the repository first and clone your fork instead.

***

## Install dependencies

Install all project dependencies.

```bash theme={null}
uv sync
```

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.

```bash theme={null}
uv run python --version
```

You should see Python 3.12 or later.

You can also verify that the project dependencies were installed correctly.

```bash theme={null}
uv run pytest --version
```

***

## Project layout

After installation, the repository structure should look similar to:

```text theme={null}
careers-engine/
├── docs/
├── scripts/
├── src/
├── tests/
├── pyproject.toml
└── uv.lock
```

***

## Next step

The project is now installed.

Continue with the configuration guide to configure environment variables, the Discord bot, and the required repositories.

<Card title="Configuration" icon="gear" href="/getting-started/configuration" />