49 lines (35 loc) · 1.36 KB

Contributing to Vibrance

First off, thank you for considering contributing to Vibrance! It's people like you that make open source such a great community.

🛠 Development Workflow

This is a monorepo managed with pnpm.

Prerequisites

Node.js
pnpm workspace enabled

Getting Started

Fork & Clone Fork the repository on GitHub and clone your fork locally.
Install Dependencies
```
pnpm install
```
Development Server To run both the React Vite frontend and the Express backend concurrently:
```
pnpm run dev
```
Type Checking Before submitting your PR, ensure all TypeScript checks pass:
```
pnpm run typecheck
```

📝 Pull Request Process

Create a new branch for your feature or bugfix (git checkout -b feature/amazing-feature)
Make your changes following the existing code style.
Commit your changes with descriptive messages.
Push your branch to your fork.
Open a Pull Request targeting the main branch.

💻 Tech Stack Guidelines

Frontend: React 19 + Radix UI + Tailwind CSS. Use compound component patterns where appropriate.
Backend: Express.js + Drizzle ORM.
API Types: All Zod schemas serve as the single source of truth and belong in @workspace/api-zod. Define them before implementing routes.

Once again, thank you for contributing!