Blackcreek DBMS

Django & Spring Boot based database management system with PostgreSQL, Redis.

---

Table of Contents

• Quick Start
• Database Setup
• Development Commands
• Troubleshooting
• Contributing
• System Architecture

---

Quick Start

Prerequisites: Python 3.8+, Docker, Docker Compose, Git

Static files note (important): When running make run, if prompted to collect static files, enter yes. When DEBUG = False in settings.py, Django does not automatically serve static files (it assumes a web server like NGINX will handle them). This is something we still need to investigate/standardize.

Migration note: If you see any migration warnings, run migrations before continuing:

• macOS/Linux: make migrate
• Windows: python manage.py migrate

macOS/Linux	Windows
git clone https://github.com/yublueprint/blackcreek_dbms.git cd blackcreek_dbms make build make migrate make run make signup make test make lint make lint-fix	git clone https://github.com/yublueprint/blackcreek_dbms.git cd blackcreek_dbms python -m venv venv venv\Scripts\activate pip install -r requirements.txt python manage.py migrate python manage.py collectstatic python manage.py runserver python manage.py createsuperuser

Access: http://127.0.0.1:8000

---

Database Setup

docker compose up -d      # Start
docker compose down       # Stop
docker compose down -v    # Stop + delete data

Service	URL	Credentials	Purpose
Django App	localhost:8000	Via signup	Main application
PostgreSQL	localhost:5433	user: user password: user	Primary database
pgAdmin	localhost:5050	email: admin@blackcreek.com password: admin	Database management
Redis	localhost:6379	No authentication	Caching & sessions
Redis Commander	localhost:8081	No authentication	Redis monitoring

Redis Configuration

Redis is used for background tasks.

Test Redis connection:

redis-cli ping
# Should return "PONG"

Trigger analytics manually:

redis-cli lpush analytics_events '{ "event": "Hello, Black Creek Farm!" }'

---

Development Commands

Environment Reset:

• macOS/Linux: make clean && make build && make migrate
• Windows: Delete venv folder, recreate with python -m venv venv

---

Troubleshooting

Common Issues:

Problem	Fix
Port 8000 in use	Kill process or change port: sudo lsof -i :8000 → sudo kill -9 PID
Database error	Check docker compose ps
Permission denied	Use sudo or add user to docker group
Staticfiles not updating.	make clean && make build

---

Contributing

Before pushing changes

make test
make lint-fix
make lint

Push changes

git checkout -b feature/your-feature
git commit -m "Add feature" -m "Description"
git push origin feature/your-feature
# Open pull request

---

System Architecture

Application Architecture

graph TB
    subgraph "Client Layer"
        Client[Client/Browser]
    end
    
    subgraph "Application Layer - Azure Kubernetes"
        Ingress[Ingress Controller<br/>Load Balancer]
        Django[Django App<br/>Core Service & Producer<br/>Frontend + Backend]
        Analytics[Analytics Engine<br/>Spring Boot<br/>Consumer Service]
    end
    
    subgraph "Data Layer"
        Redis[(Redis<br/>Message Queue/Cache)]
        PostgreSQL[(PostgreSQL<br/>Database)]
    end
    
    Client -->|HTTP Requests| Ingress
    Ingress -->|Route| Django
    Django -->|Publish Events| Redis
    Django -->|Read/Write| PostgreSQL
    Redis -->|Consume Events| Analytics
    Analytics -->|Read/Write| PostgreSQL
    
    style Django fill:#0c4b33,stroke:#333,stroke-width:2px,color:#fff
    style Analytics fill:#2563eb,stroke:#333,stroke-width:2px,color:#fff
    style Redis fill:#dc2626,stroke:#333,stroke-width:2px,color:#fff
    style PostgreSQL fill:#336791,stroke:#333,stroke-width:2px,color:#fff
    style Client fill:#64748b,stroke:#333,stroke-width:2px,color:#fff
    style Ingress fill:#00d9ff,stroke:#333,stroke-width:2px,color:#000

Loading

CI/CD Pipeline

graph LR
    subgraph "CI/CD Pipeline"
        subgraph "Docker Container Orchestration"
            Docker[Docker<br/>Container Orchestration]
        end
        
        subgraph "Testing Machines"
            Lint[Lint Machine<br/>Code Quality Checks]
            Unit[Test Machine<br/>Unit Testing]
            E2E[E2E Test Machine<br/>End-to-End Testing]
        end
        
        subgraph "Notification & Deployment"
            Notify[Notify<br/>Notifications]
            Deploy[Deploy to AKS<br/>Azure Deployment]
        end
        
        Docker -->|Trigger| Lint
        Docker -->|Trigger| Unit
        Docker -->|Trigger| E2E
        
        Lint -->|Results| Notify
        Unit -->|Results| Notify
        E2E -->|Results| Notify
        
        Notify -->|Success| Deploy
        
        style Docker fill:#2496ed,stroke:#333,stroke-width:2px,color:#fff
        style Lint fill:#ff8c42,stroke:#333,stroke-width:2px,color:#fff
        style Unit fill:#2dd4bf,stroke:#333,stroke-width:2px,color:#fff
        style E2E fill:#6366f1,stroke:#333,stroke-width:2px,color:#fff
        style Notify fill:#a855f7,stroke:#333,stroke-width:2px,color:#fff
        style Deploy fill:#ec4899,stroke:#333,stroke-width:2px,color:#fff
    end
    
    subgraph "Client Layer"
        Client2[Client/Browser]
    end
    
    Deploy -->|Update| Client2
    Client2 -->|HTTP Requests| Deploy
    
    style Client2 fill:#64748b,stroke:#333,stroke-width:2px,color:#fff

Loading

---

Questions? Open an issue | Part of YU Blueprint initiative