https://github.com/yashraj-n/aura-code-review-hackaithon

https://github.com/yashraj-n/aura-code-review-hackaithon

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/yashraj-n/aura-code-review-hackaithon
• Owner: yashraj-n
• Created: 2025-03-09T06:43:56.000Z (3 months ago)
• Default Branch: master
• Last Pushed: 2025-03-21T16:48:12.000Z (2 months ago)
• Last Synced: 2025-03-21T17:38:20.038Z (2 months ago)
• Language: TypeScript
• Size: 410 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


# Aura Code Review



Aura is an intelligent code review assistant that leverages AI to streamline your GitHub workflow. It automatically analyzes pull requests, suggests improvements, identifies bugs, and generates optimized code—helping developers ship higher quality software faster.



---

![Bun](https://img.shields.io/badge/Bun-000?logo=bun&logoColor=fff)

![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?logo=typescript&logoColor=fff)

![Postgres](https://img.shields.io/badge/Postgres-%23316192.svg?logo=postgresql&logoColor=white)

![Drizzle](https://img.shields.io/badge/Drizzle-C5F74F?logo=drizzle&logoColor=000)

![GitHub](https://img.shields.io/badge/GitHub-%23121011.svg?logo=github&logoColor=white)

## Features

- **Automated Code Reviews**: Automatically analyzes pull requests when they are opened, providing detailed feedback on code quality, potential bugs, and suggestions for improvements.

- **Comment-Based Interactions**: Responds to mentions in issue comments, allowing users to request specific actions.

- **Structural Code Analysis**: Transforms unstructured code reviews into structured feedback for better readability and actionability.

- **Repository Indexing**: Indexes and embeds repository content for context-aware code analysis.

- **Markdown-Formatted Feedback**: Generates well-formatted markdown reports for clear and organized feedback.

- **Error Handling**: Built-in error handling and logging for reliable operation.

## Prerequisites

### LLM Keys

- [Mistral](https://mistral.ai)

- [OpenRouter](https://openrouter.ai)

- [Langsmith](https://smith.langchain.com)

### Github App

- [Create a Github App](https://docs.github.com/en/apps/creating-github-apps/about-creating-github-apps)

- Add the following permissions:

    - Read and Write Metadata

    - Read and Write Code

    - Read and Write Pull Requests

### Database

- Any Postgres database with PGVector extension

Add the above keys to the `.env` file

### Enviroment

- Make sure to have [Bun](https://bun.sh) installed

## Setup

1. Clone the repo

```bash

git clone https://github.com/yashraj-n/aura-code-review

```

2. Install dependencies

```bash

bun install

```

3. Run the server

```bash

bun run dev

```

🚀 The Github App will be installed automatically when you run the server.