[Brief description of your project in 1-2 sentences]
[Explain what your project does and the problem it solves. This section should give readers a clear understanding of the project's purpose.]
- Feature 1: [Description]
- Feature 2: [Description]
- Feature 3: [Description]
- Feature 4: [Description]
- Node.js 20+
- [Other requirements]
# Clone and install
git clone <repo-url>
cd [project-name]
npm install
# Set up environment
cp .env.example .env
# Edit .env with your credentials
# Initialize database (if applicable)
npx prisma db push
# Start development server
npm run dev# Required
DATABASE_URL="file:./dev.db"
NEXTAUTH_URL="http://localhost:3000"
NEXTAUTH_SECRET="your-secret-here"
# Optional
# Add your environment variables here[High-level architecture diagram or description]
[Brief description of how the system works]
| Document | Purpose |
|---|---|
| CLAUDE.md | AI agent development instructions |
| docs/PRD.md | Product requirements |
| docs/ARCHITECTURE.md | System architecture |
| docs/API_SPEC.md | API reference |
| docs/DOCUMENTATION_MAP.md | Full documentation index |
- Framework: Next.js 14+ (App Router)
- Language: TypeScript
- Styling: TailwindCSS
- Database: Prisma (PostgreSQL/SQLite)
- Auth: NextAuth.js
[Your license here]