This is the backend API, CronJob manager (responsible for periodically seeking and queuing jobs) and Worker containers (responsible for processing jobs) for the TheSkoop project
If you want to skip the workspace setup process, you can run the local docker image via docker compose (hot reloads will be slightly slower than using yarn dev):
src/server $ cat .env-example > .env
src/server $ docker compose up api-local
src/server $ docker compose up scheduler-local
src/server $ docker compose up worker-localFirst make sure you already have NPM and PNPM installed.
npm i -g yarnThis project also is fully ESM so make sure your node version is >= 18.
~ $ git clone [email protected]:NoodleOfDeath/readless.git
~ $ cd readless/src/server
src/server $ yarn install
src/server $ cat .env-example > .env
src/server $ yarn dev:api
src/server $ yarn dev:scheduler
src/server $ yarn dev:workerWhen making a PR please name your branch something like <your-initials>/feat/server/feature-name or <your-initials>/fix/server/fix-name then request my review!