> ## 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.

# Configuration

> Configure the project.

Before running careers-engine, a few project components must be configured.

The platform is designed around two repositories:

* **careers-engine** contains the discovery, processing, and publishing logic.
* **careers-data** stores the persistent job database, publishing state, and historical data generated by the platform.

Together, these repositories provide a reproducible and version-controlled workflow for discovering and publishing software engineering opportunities.

***

## Repository layout

Clone both repositories into the same workspace.

```bash theme={null}
workspace/
├── careers-engine/
└── careers-data/
```

Clone the companion repository.

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

<Info>
  `careers-data` acts as the persistent storage layer for careers-engine. Every discovery and publishing workflow reads from or writes to this repository.
</Info>

***

## Environment variables

Create a `.env` file in the project root.

```text theme={null}
careers-engine/
├── .env
├── src/
├── scripts/
└── ...
```

The project requires several environment variables to access external services and locate the companion repository.

```env theme={null}
DISCORD_TOKEN=...
DISCORD_CHANNEL_ID=...

DATA_DIR=../careers-data
```

Additional variables may be required depending on the workflow being executed.

***

## Workspace structure

After configuration, your workspace should resemble:

```text theme={null}
workspace/
├── careers-engine/
│   ├── .env
│   ├── docs/
│   ├── scripts/
│   └── src/
│
└── careers-data/
    ├── data/
    ├── queue/
    └── ...
```

***

## Next step

The project is now configured.

Continue by running careers-engine locally and verifying that your environment has been set up correctly.

<Card title="Running Locally" icon="play" href="/getting-started/running-locally" />