Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pyqdeck.in/llms.txt

Use this file to discover all available pages before exploring further.

​
Prerequisites

Ensure you have the following installed on your machine:
  • Node.js: v20 or higher
  • pnpm: v10 or higher
  • MongoDB: A local instance or an Atlas connection string

​
Local Setup

  1. Clone the repository: 
    git clone https://github.com/pyqdeck/pyqdeck-backend-express.git
cd pyqdeck-backend-express
  2. Install dependencies: Run this from the root to install all workspace dependencies: 
    pnpm install
  3. Configure Environment Variables: Create .env files in both backend/ and frontend/ using the provided .env.example templates.

​
Running the Platform

We use a monorepo structure, but you can run components individually using the following commands:

​
Backend (API)

cd backend
pnpm dev
The API will be available at http://localhost:5000. Swagger documentation is at /api-docs.

​
Frontend (Web)

cd frontend
pnpm dev
The web app will be available at http://localhost:3000.

​
Storybook (UI Components)

cd frontend
pnpm run storybook
View the component library at http://localhost:6006.

​
Key Workflows

​
🔄 API & SDK Sync

We use a type-safe SDK for frontend-backend communication. If you change a backend route or model:
  1. Run pnpm run openapi:export in the backend/ folder.
  2. Run pnpm run gen:api in the frontend/ folder.

​
🧪 Testing

  • Backend: Run pnpm test in the backend/ folder to execute Vitest suites.
  • Frontend: Run pnpm lint to check for code quality issues.