Skip to main content

​
Get started in three steps

This guide is for new engineers who want to get the PLEC platform running locally.

​
Step 1: Clone the repos

Frontend (Web)
git clone https://github.com/DevAtVenues/platform-frontend.git
Backend (API)
git clone https://github.com/DevAtVenues/platform-backend.git
Put both repos in the same parent folder (e.g. ~/projects/plec/) for an easier dev flow.

​
Step 2: Install deps + run locally

From the frontend repo:
cd platform-frontend
npm install
npm run dev
Your frontend dev server should print the local URL (commonly http://localhost:5173).
From the backend repo:
cd platform-backend
npm install
npm run start:dev
If port 3000 is in use, you can run on another port: PORT=3001 npm run start:dev

​
Step 3: Verify everything is working

Backend health
curl -s http://localhost:3000/health
OpenAPI JSON (used by Mintlify)
curl -s http://localhost:3000/docs-json | jq '.openapi, (.paths|length)'
If your backend is running on 3001, update the URLs accordingly.
Make sure your frontend points to the backend base URL you’re running locally (commonly http://localhost:3000 or http://localhost:3001).
Check the frontend’s .env* files for something like VITE_API_URL / VITE_API_BASE_URL.

​
Next steps

Local development details

Environment variables, common issues, and debugging.

API reference

Explore endpoints and test requests in the playground.

Docs navigation

How the docs structure works and how to add pages.

Writing MDX

Add guides and engineering notes quickly.
If you get stuck: confirm ports, confirm environment variables, and check the backend logs for CORS or missing config errors.