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.
Clone the companion repository.
careers-data acts as the persistent storage layer for careers-engine. Every discovery and publishing workflow reads from or writes to this repository.
Environment variables
Create a .env file in the project root.
The project requires several environment variables to access external services and locate the companion repository.
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.
