Prerequisites
Before you begin, ensure you have the following installed:1. Clone the Repository
2. Install Dependencies
3. Configure Environment Variables
The app reads from a file atconfig/env/.env (resolved relative to process.cwd()).
config/env/.env and fill in at minimum the required variables:
See Environment Variables for a full
reference of every variable and which are optional.
4. Set Up the Database
Make sure your PostgreSQL instance is running, then create the database:5. Run Database Migrations
db/migration/ to your database.
6. (Optional) Seed an Admin User
7. Start the Development Server
http://localhost:3000.
Open
http://localhost:3000/api/v2/docs — you should see the Swagger UI for
the user-facing API.Using Docker (Alternative)
If you prefer Docker, aDockerfile is included.
Useful Scripts
What’s Next?
Architecture Overview
Understand how all systems fit together
API Reference
Explore every endpoint
Environment Variables
Full env var reference
Admin Guide
Manage users, content and config