Skip to main content
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 job records, destination-specific publication history, and queued opportunities.
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.
Clone the companion repository.
careers-data acts as the persistent storage layer for Careers Engine. Discovery and publishing workflows read from or update this repository.

Environment variables

Create a .env file in the project root.
Configure the environment variables required for publishing and persistent storage.

Single Server Deployment

DISCORD_GUILD_ID restricts the bot to a single Discord server. If the bot joins another server, it automatically leaves and publishes opportunities only to the configured guild.
Additional variables may be required depending on the workflow being executed.

Workspace structure

After configuration, your workspace should resemble:

Next step

The project is now configured. Continue by running Careers Engine locally and verifying that your environment has been set up correctly.

Running Locally