Skip to content

adarshvision1/FirstPR

Repository files navigation

FirstPR

Gemini 3 powered repository analysis and onboarding assistant.

Quick Start

Backend

  1. Navigate to backend/:
    cd backend
  2. Setup environment (if not done):
    python -m venv .venv
    .venv\Scripts\activate
    pip install -r requirements.txt # or manually install dependencies
    cp .env.example .env # edit .env with your keys
  3. Run the server:
    .venv\Scripts\python.exe -m uvicorn src.main:app --reload --port 8000

Frontend

  1. Navigate to frontend/:
    cd frontend
  2. Install dependencies:
    npm install
  3. Run dev server:
    npm run dev

CLI Tool

Use the CLI to test analysis directly:

.\backend\.venv\Scripts\python.exe backend/firstpr-cli.py analyze octocat/Hello-World

Testing

To run backend tests:

$env:GOOGLE_API_KEY="test"; .\backend\.venv\Scripts\python.exe -m pytest backend/tests/test_github_client.py

Docker Quick Start (Recommended)

The easiest way to run the application is with Docker Compose.

  1. Ensure Docker is installed.
  2. Create a .env file in the root directory and set your GOOGLE_API_KEY and GITHUB_TOKEN.
  3. Run:
    docker-compose up --build
  4. Open http://localhost:3000 for the app. The backend API will be available at http://localhost:8000/api.

Deployment

See DEPLOY.md for Google Cloud Run deployment instructions.

About

FirstPR turns any GitHub repository into a clear, actionable onboarding guide. It analyzes the codebase, explains the architecture, highlights key files and functions, and suggests beginner-friendly issues so developers can understand a project faster and confidently open their first meaningful pull request.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors