https://github.com/arnavk-09/gh-pr-ai
Minimal AI-driven tool that helps developers review GitHub Pull Requests efficiently...
https://github.com/arnavk-09/gh-pr-ai
ai backend bun demo elysia flagsmith groq html react starter vercel-ai
Last synced: 7 months ago
JSON representation
Minimal AI-driven tool that helps developers review GitHub Pull Requests efficiently...
- Host: GitHub
- URL: https://github.com/arnavk-09/gh-pr-ai
- Owner: ArnavK-09
- License: other
- Created: 2025-03-18T19:52:15.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-03-20T15:56:38.000Z (7 months ago)
- Last Synced: 2025-03-23T01:35:44.451Z (7 months ago)
- Topics: ai, backend, bun, demo, elysia, flagsmith, groq, html, react, starter, vercel-ai
- Language: HTML
- Homepage: https://gh-pr-ai.onrender.com
- Size: 313 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
🔫 gh-pr-ai 🔫
AI-Powered GitHub PR Review Assistant
> [!NOTE]
>
> gh-pr-ai is a powerful AI-driven tool that helps developers review GitHub Pull Requests efficiently. It provides detailed code analysis and suggestions in real-time, making the code review process smoother and more effective.
## 🌟 Features
> **gh-pr-ai** comes packed with powerful features:
- **AI-Powered Analysis** – Intelligent code review with detailed suggestions
- **Real-time Processing** – Instant feedback as you review PRs
- **Feature Flag Management** – Flexible control using Flagsmith integration
- **Modern UI** – Clean and responsive interface with typing animation
## 💻 Installation
> Get started with **gh-pr-ai** in minutes:
```bash
# Clone the repository
git clone https://github.com/ArnavK-09/gh-pr-ai.git
# Install dependencies
bun install
# Start the development server
bun run dev
```
## 🚀 Live Demo
> [!TIP]
> Experience gh-pr-ai in action at: [gh-pr-ai.onrender.com](https://gh-pr-ai.onrender.com)
## 🛠️ Tech Stack
### Backend
- **Bun** – Fast all-in-one JavaScript runtime
- **Elysia.js** – Modern and performant web framework
- **SQLite** – Lightweight and reliable database
- **Vercel AI SDK** – Advanced AI integration
### Frontend
- **React** – UI library for interactive components
- **Tailwind CSS** – Utility-first styling framework
- **Marked** – Markdown parsing and rendering
## 🎯 Flagsmith Integration
gh-pr-ai leverages Flagsmith for feature flag management, enabling:
- Dynamic feature toggling
- Environment-specific configurations
- Gradual feature/CONFIG rollouts
The integration is handled in `src/flagsmith.ts`, making it easy to manage feature flags across the application.
### Feature Flags Overview
Below is a comprehensive list of feature flags used in gh-pr-ai:
| Flag Name | Description | Default State | Impact |
|-----------|-------------|---------------|--------|
| `enableAIReview` | Controls AI-powered code review functionality | Enabled | Activates intelligent code analysis and suggestions |
| `useMarkdown` | Toggle Markdown rendering in PR comments | Enabled | Enables rich text formatting in review comments |
| `debugMode` | Enables detailed logging and debugging features | Disabled | Shows additional debugging information for development |
| `experimentalFeatures` | Controls access to experimental features | Disabled | Enables testing of new features before full release |
### Flagsmith Dashboard
> Here's how our feature flags are managed in the Flagsmith dashboard:
| Screenshot |
|------------|
|  |
|  |
|  |
|  |
|  |
|  |
## 📁 Project Structure
```
├── src/ # Backend source files
│ ├── flagsmith.ts # Flagsmith configuration
│ ├── index.ts # Main server entry
│ ├── lib/ # Core utilities
│ ├── routers/ # API route handlers
│ └── types.ts # TypeScript definitions
├── frontend/
│ └── index.html # Single-file React frontend
└── package.json # Project dependencies
```
## 💻 Contributing
> [!TIP]
> We welcome contributions to improve **gh-pr-ai**! If you have suggestions, bug fixes, or new feature ideas, follow these steps:
1. **Fork the Repository**
Click the **Fork** button at the top-right of the repo page.
2. **Clone Your Fork**
Clone the repo locally:
```bash
git clone https://github.com/ArnavK-09/gh-pr-ai.git
```
3. **Create a Branch**
Create a new branch for your changes:
```bash
git checkout -b your-feature-branch
```
4. **Make Changes**
Implement your changes (bug fixes, features, etc.).
5. **Commit and Push**
Commit your changes and push the branch:
```bash
git commit -m "feat(scope): description"
git push origin your-feature-branch
```
6. **Open a Pull Request**
Open a PR with a detailed description of your changes.
7. **Collaborate and Merge**
The maintainers will review your PR, request changes if needed, and merge it once approved.
## 🙋♂️ Issues
Found a bug or need help? Please create an issue on the [GitHub repository](https://github.com/ArnavK-09/gh-pr-ai/issues) with a detailed description.
## 👤 Author
---
📄 License
gh-pr-ai is licensed under the MIT License. See the LICENSE file for more details.
---
🌟 If you find this project helpful, please give it a star on GitHub! 🌟
