• Docker and Docker Compose
• (Optional) A GitHub OAuth App for live GitHub access

git clone https://github.com/mesubbu/gitvibeDev.git
cd gitvibeDev

Option A — Local (no Docker):

make local

This creates a Python venv, installs dependencies, and starts the backend + frontend dev server. Visit http://localhost:3000.

Option B — Docker:

make up

This starts the backend, frontend, and Ollama in Docker. Visit http://localhost:3000.

Option C — Frontend-only secure demo (no backend):

cp .env.example .env
APP_MODE=demo docker compose --env-file .env up -d frontend

This starts only Nginx + frontend with local mock API/auth/storage.

Option D — One-click installer script:

bash installer/install.sh --skip-clone --target-dir . --mode development

For frontend-only demo mode:

bash installer/install.sh --skip-clone --target-dir . --mode demo

Set APP_MODE=demo to run the secure offline demo — no GitHub credentials needed.
You get seeded repos, PRs, issues, and AI review responses stored locally in the browser.

Set one variable to switch behavior:

APP_MODE=demo|development|production

Create a .env file (or edit the auto-generated one):

DEMO_MODE=false
GITHUB_CLIENT_ID=your_oauth_client_id
GITHUB_CLIENT_SECRET=your_oauth_client_secret

Then restart:

make down && make up

┌─────────────┐     ┌─────────────────┐     ┌──────────┐
│   Browser    │────▶│  Nginx (:3000)  │────▶│  Backend  │
│   (SPA)      │     │  Static + Proxy │     │  FastAPI  │
└─────────────┘     └─────────────────┘     │  (:8000)  │
                                             └─────┬─────┘
                                                   │
                                    ┌──────────────┼──────────────┐
                                    │              │              │
                              ┌─────▼─────┐ ┌─────▼─────┐ ┌─────▼─────┐
                              │  GitHub   │ │  Ollama   │ │   Vault   │
                              │  REST API │ │  (AI)     │ │  (Secrets)│
                              └───────────┘ └───────────┘ └───────────┘

Backend: Python FastAPI with JWT auth, RBAC, CSRF protection, rate limiting, audit logging.
Frontend: Lightweight SPA served by Nginx, calling real backend APIs.
AI: Pluggable providers — Ollama (local) or any OpenAI-compatible API.
Storage: Encrypted file vault for tokens and secrets. No database required by default.

Stop local services with make local-stop.

All configuration via environment variables (.env file):

See .env.example for the full list.

# Install dev dependencies
make dev-deps

# Fast unit tests
make test-fast

# Full test suite
make test

# With coverage report
make coverage

We welcome contributions! See CONTRIBUTING for guidelines.

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing)
3. Make your changes
4. Run tests (make test)
5. Submit a pull request

Licensed under the Apache License 2.0.