Skip to content

Quick Start Guide

Get GitPulse up and running in minutes with our quick start guide.

Prerequisites

  • Docker and Docker Compose installed
  • Git
  • At least 16GB of RAM available (8GB minimum, 16GB recommended)

Step 1: Clone and Configure

git clone https://github.com/assiadialeb/gitpulse.git
cd GitPulse
cp env.example .env

Step 2: Start Services

docker-compose up -d --build

This will start all required services:

  • PostgreSQL 17: Django database
  • MongoDB 7.0: Analytics database
  • Ollama: AI for commit classification and analysis
  • Django: Web application

Note: First startup may take 5-10 minutes as Ollama downloads the gemma3:4b model (~3.3GB).

Step 3: Access

  • Application: http://localhost:8000
  • Django Admin: http://localhost:8000/admin
  • Ollama API: http://localhost:11435

🔧 Essential Commands

# Start services
docker-compose up -d

# Stop services
docker-compose down

# View logs
docker-compose logs -f

# Django shell
docker-compose exec web python manage.py shell

# PostgreSQL shell
docker-compose exec postgres psql -U gitpulse -d gitpulse

🖥️ Option 2: Local Installation

Prerequisites

  • Python 3.12+
  • PostgreSQL (recommended) or SQLite
  • MongoDB
  • Git
  • At least 16GB of RAM available (8GB minimum, 16GB recommended)

Step 1: Clone Repository

git clone https://github.com/assiadialeb/gitpulse.git
cd GitPulse

Step 2: Create Virtual Environment

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

Step 3: Install Dependencies

pip install -r requirements.txt

Step 4: Configure Environment

cp env.example .env
# Edit .env with your database settings

Step 5: Run Migrations

python manage.py migrate

Step 6: Start Server

python manage.py runserver

Step 7: Access

  • Application: http://localhost:8000
  • Admin: http://localhost:8000/admin
  • Ollama API: http://localhost:11434

🔧 Essential Commands

# Start development server
python manage.py runserver

# Run tests
python manage.py test

# Create migrations
python manage.py makemigrations

# Apply migrations
python manage.py migrate

# Django shell
python manage.py shell

🚨 Troubleshooting

Common Issues

Ports already in use

# Check what's using port 8000
lsof -i :8000

# Kill the process
kill -9 <PID>

Database connection issues

# Check if PostgreSQL is running
docker-compose ps postgres

# Check logs
docker-compose logs postgres

Permission issues

# Fix file permissions
chmod +x manage.py

Getting Help