Contributing to QuickDraw

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

Getting Started

Prerequisites

• Node.js: Version 22
• pnpm: Version 9.x (Required for monorepo)
• Docker: For running the local database

Local Setup

git clone https://github.com/rajputdivyanshu81/QuickDraw.git
cd QuickDraw
pnpm install

Database Setup

We use Docker Compose to make database setup effortless.

docker-compose up -d
pnpm db:generate

Running Development

pnpm dev

Monorepo Structure

QuickDraw uses a modular monorepo architecture:

• apps/excelidraw-frontend: The main drawing application.
• apps/http-backend: REST API for users and rooms.
• apps/ws-backend: WebSocket server for real-time sync.
• apps/docs: This documentation site!
• packages/ui: Shared React component library.

Pull Request Process

1. Create a feature branch from main.
2. Ensure all CI checks pass (pnpm lint, pnpm check-types).
3. Submit your PR with a clear description and screenshots if applicable.