Skip to content
This repository was archived by the owner on Apr 21, 2025. It is now read-only.

README.md

Latest commit

 

History

History
42 lines (30 loc) · 1.74 KB

README.md

File metadata and controls

42 lines (30 loc) · 1.74 KB

Read Less Backend

API CI scheduler CI Worker CI

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

Getting Started - TL;DR Style (aka Docker)

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-local

Getting Started (Workspace Setup - Recommended for Development)

First make sure you already have NPM and PNPM installed.

npm i -g yarn

This project also is fully ESM so make sure your node version is >= 18.

~ $ git clone git@github.com: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:worker

Contribution

When 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!