Toolchain. Node.js 22.x (
>=22.12.0 <23.0.0) and pnpm 10.6.1, both declared in the repository root package.json. The pnpm version comes from the packageManager field.Set up your machine
Install the prerequisites and get the stack running locally.
Architecture overview
Read this before writing code: how the services fit together, and how a post travels from the editor to a connected network.
Repository overview
PostQueen is open source. The application source code lives at github.com/GkhanKINAY/postqueen-app. It is a monorepo built on pnpm workspaces. The workspace globs inpnpm-workspace.yaml are apps/* and libraries/*.
A single
.env file at the repository root is shared by all apps, which keeps local development and deployment configuration in one place. Copy .env.example to .env to start.Apps
Shared code lives under
libraries/: the NestJS libraries used by the backend and orchestrator, and the shared React components used by the frontend.
Database
The backend uses Prisma as the ORM with PostgreSQL as the database. The schema lives here:Scheduling and background work
She keeps the schedule in Temporal. When Thursday at 9 AM arrives, the workflow the orchestrator app registered wakes and she posts.Redis caches and queues. It never holds a schedule.
Common commands
All commands run from the repository root with pnpm. The main scripts inpackage.json:
Useful narrower scripts:
With
pnpm run dev running and no errors in the output, the frontend, backend and orchestrator are all up together. You are ready to change her.Contributing
The contributors guide lives in the main repository. It covers how to contribute, including the expected format for pull requests.Next steps
Add a provider
What a new network needs on the backend and on the frontend.
Configuration reference
Every environment variable she reads, and what it changes.
Dev Container
The same environment inside a container, with Node, pnpm and the databases already in place.
Public API
The REST surface your code and her agents both call.