|
1 | | -This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app). |
| 1 | +# DocuCraft — AI Documentation from Your GitHub Repos |
2 | 2 |
|
3 | | -## Getting Started |
| 3 | +DocuCraft automatically generates PR descriptions, changelogs, and documentation from your GitHub repositories. |
| 4 | + |
| 5 | +## Phase 0: PR Pilot |
| 6 | + |
| 7 | +The initial release ("PR Pilot") focuses on two core features: |
| 8 | +- **Auto PR Descriptions** — Every pull request gets a clear, well-structured description generated from code changes |
| 9 | +- **Changelog Generation** — Generate release notes from merged PRs with one click |
| 10 | + |
| 11 | +## Tech Stack |
| 12 | + |
| 13 | +- **Frontend:** Next.js 16, React 19, Tailwind CSS v4, shadcn/ui |
| 14 | +- **Backend:** Next.js API routes (serverless) |
| 15 | +- **Database:** Supabase (Postgres) |
| 16 | +- **AI:** OpenAI (GPT-4o-mini) |
| 17 | +- **Auth:** GitHub App OAuth |
| 18 | +- **Deployment:** Vercel (frontend + API), Railway (background tasks), Supabase (DB) |
4 | 19 |
|
5 | | -First, run the development server: |
| 20 | +## Getting Started |
6 | 21 |
|
7 | 22 | ```bash |
8 | | -npm run dev |
9 | | -# or |
10 | | -yarn dev |
11 | | -# or |
12 | | -pnpm dev |
13 | | -# or |
14 | | -bun dev |
15 | | -``` |
| 23 | +# Copy environment variables |
| 24 | +cp .env.example .env.local |
16 | 25 |
|
17 | | -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. |
| 26 | +# Fill in your credentials: |
| 27 | +# - Supabase project URL and keys |
| 28 | +# - GitHub App credentials |
| 29 | +# - OpenAI API key |
18 | 30 |
|
19 | | -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. |
| 31 | +# Run development server |
| 32 | +npm run dev |
| 33 | +``` |
20 | 34 |
|
21 | | -This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel. |
| 35 | +## Environment Variables |
22 | 36 |
|
23 | | -## Learn More |
| 37 | +| Variable | Description | |
| 38 | +|----------|-------------| |
| 39 | +| `NEXT_PUBLIC_SUPABASE_URL` | Supabase project URL | |
| 40 | +| `NEXT_PUBLIC_SUPABASE_ANON_KEY` | Supabase anonymous key | |
| 41 | +| `SUPABASE_SERVICE_ROLE_KEY` | Supabase service role key | |
| 42 | +| `GITHUB_APP_ID` | GitHub App ID | |
| 43 | +| `GITHUB_APP_CLIENT_ID` | GitHub App client ID | |
| 44 | +| `GITHUB_APP_CLIENT_SECRET` | GitHub App client secret | |
| 45 | +| `GITHUB_APP_PRIVATE_KEY` | GitHub App private key | |
| 46 | +| `GITHUB_APP_WEBHOOK_SECRET` | GitHub App webhook secret | |
| 47 | +| `OPENAI_API_KEY` | OpenAI API key | |
| 48 | +| `OPENAI_MODEL` | OpenAI model (default: gpt-4o-mini) | |
| 49 | +| `NEXT_PUBLIC_APP_URL` | App URL (http://localhost:3000 for dev) | |
24 | 50 |
|
25 | | -To learn more about Next.js, take a look at the following resources: |
| 51 | +## Architecture |
26 | 52 |
|
27 | | -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. |
28 | | -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. |
| 53 | +1. **GitHub App** receives `pull_request` webhook events |
| 54 | +2. **Webhook handler** fetches PR diff, generates AI description via OpenAI |
| 55 | +3. **AI description** posted as PR comment and stored in Supabase |
| 56 | +4. **Dashboard** displays repos, PRs, and generated changelogs |
| 57 | +5. **Changelog generation** groups merged PRs and generates release notes |
29 | 58 |
|
30 | | -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome! |
| 59 | +## Pricing |
31 | 60 |
|
32 | | -## Deploy on Vercel |
| 61 | +- **Free** — Open source repos |
| 62 | +- **$29/mo Pro** — Individual developers, private repos |
| 63 | +- **$79/mo Team** — Small teams, multiple installations |
33 | 64 |
|
34 | | -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. |
| 65 | +## License |
35 | 66 |
|
36 | | -Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details. |
| 67 | +MIT |
0 commit comments