@@ -13,25 +13,56 @@ A GitHub App for automated code reviews using Hono.js and Amp.
1313
1414## Quick Start
1515
16+ ### Local Development
17+
16181 . ** Clone and Install**
1719 ``` bash
1820 cd cra-github
1921 pnpm install
2022 ```
2123
22- 2 . ** Environment Setup**
24+ 2 . ** Build (required for MCP server)**
25+ ``` bash
26+ pnpm run build
27+ ```
28+
29+ 3 . ** Environment Setup**
2330 ``` bash
2431 cp .env.example .env
2532 ```
2633
27- 3 . ** Start Development Server**
34+ 4 . ** Start Development Server**
2835 ``` bash
2936 pnpm run dev
3037 ```
3138
32- 4 . ** Install the App**
33- - Visit ` {APP_BASE_URL}/github/install ` (e.g., ` https://your-ngrok-url.app/github/install ` )
34- - Follow the GitHub App installation flow
39+ ### Docker Setup
40+
41+ 1 . ** Create GitHub App**
42+ - Go to GitHub Settings > Developer settings > GitHub Apps > New GitHub App
43+ - Set webhook URL to placeholder (e.g., ` https://example.com/webhook ` )
44+ - Download private key, note App ID and webhook secret
45+
46+ 2 . ** Configure Environment**
47+ ``` bash
48+ cp .env.example .env
49+ # Fill in GitHub App credentials from step 1
50+ # For Docker, use GITHUB_APP_PRIVATE_KEY (base64) instead of file path:
51+ # cat private-key.pem | base64 -w 0
52+ ```
53+
54+ 3 . ** Start Container**
55+ ``` bash
56+ docker compose up --build
57+ # or with Podman: podman-compose up --build
58+ ```
59+
60+ 4 . ** Update Webhook URL**
61+ - For local dev: start ngrok (` ngrok http 5053 ` )
62+ - Update GitHub App webhook URL to ` https://your-url/github/webhook `
63+
64+ 5 . ** Install the App**
65+ - Visit ` http://localhost:5053/github/install `
3566 - Select repositories to enable code reviews
3667
3768## Configuration
0 commit comments