🛑 The Problem
Open Source projects die without contributors, and contributors abandon projects if they can't get the app running locally within 10 minutes. Right now, setting up our Postgres database, Inngest server, and Next.js frontend is undocumented 'tribal knowledge'.
💡 The Solution
We need a comprehensive, copy-paste friendly CONTRIBUTING.md guide that holds the developer's hand from git clone to localhost:3000.
🛠️ Implementation Details
- Create
CONTRIBUTING.md in the root of the repository.
- Write sections for:
- Prerequisites (Node.js 18+, pnpm, Docker Desktop).
- Installation (
pnpm install).
- Environment Variables (How to copy
.env.example to .env).
- Database Setup (How to run
docker-compose up -d and pnpm db:push).
- Running the App (
pnpm dev).
- Include a Troubleshooting section for common errors (e.g., port 5432 already in use).
✅ Acceptance Criteria
Ready to tackle this? Comment .take below to get automatically assigned!
🛑 The Problem
Open Source projects die without contributors, and contributors abandon projects if they can't get the app running locally within 10 minutes. Right now, setting up our Postgres database, Inngest server, and Next.js frontend is undocumented 'tribal knowledge'.
💡 The Solution
We need a comprehensive, copy-paste friendly
CONTRIBUTING.mdguide that holds the developer's hand fromgit clonetolocalhost:3000.🛠️ Implementation Details
CONTRIBUTING.mdin the root of the repository.pnpm install)..env.exampleto.env).docker-compose up -dandpnpm db:push).pnpm dev).✅ Acceptance Criteria
README.md.Ready to tackle this? Comment
.takebelow to get automatically assigned!