Skip to content

SpoitHub/delux

BranchesTags

Repository files navigation

SpoitHub (MVP)

SpoitHub — учебный MVP-проект для организации спортивных мероприятий (online/offline, платные/бесплатные) и маркетплейса спортивных товаров (с покупкой/оплатой) + CRM для организаторов.

Stack

  • Backend: Django (API) + PostgreSQL
  • Frontend: React
  • Docker / Docker Compose
  • License: MIT

Структура репозитория

delux/
  backend/            # Django backend
  frontend/           # React frontend
  docker-compose.yml
  .env
  .env.example
  README.md

Быстрый старт (Docker)

1) Клонировать

git clone https://github.com/SpoitHub/delux
cd delux

2) Создать .env

Создай файл .env в корне проекта (рядом с docker-compose.yml):

# POSTGRES
POSTGRES_DB=delux
POSTGRES_USER=delux_user
POSTGRES_PASSWORD=delux_pass

# DJANGO
DJANGO_SECRET_KEY=replace_me_with_secret_key
DEBUG=1

# DATABASE (Django will use these)
DB_NAME=delux
DB_USER=delux_user
DB_PASSWORD=delux_pass
DB_HOST=db
DB_PORT=5432

3) Запуск

docker compose up --build

docker-compose.yml

version: '3.9'

services:
  db:
    image: postgres:15
    container_name: delux_db
    restart: always
    env_file:
      - .env
    ports:
      - "5432:5432"
    volumes:
      - postgres_data:/var/lib/postgresql/data

  backend:
    build: ./backend
    container_name: delux_backend
    command: python manage.py runserver 0.0.0.0:8888
    volumes:
      - ./backend:/app
    ports:
      - "8888:8888"
    depends_on:
      - db
    env_file:
      - .env

volumes:
  postgres_data:

Полезные команды

# Остановить
docker compose down

# Удалить volume БД (ОСТОРОЖНО: удалит данные)
docker compose down -v

# Миграции
docker compose exec backend python manage.py makemigrations
docker compose exec backend python manage.py migrate

# Суперпользователь
docker compose exec backend python manage.py createsuperuser

Архитектура (высокоуровнево)

flowchart LR
  subgraph Client
    U[User / Organizer]
  end

  subgraph Frontend["Frontend (React)"]
    FE[React App]
  end

  subgraph Backend["Backend (Django + DRF)"]
    API[/REST API v1/]
    SVC[Services / Business logic]
    SEL[Selectors / Queries]
  end

  subgraph Storage["Storage"]
    DB[(PostgreSQL)]
  end

  U --> FE --> API
  API --> SVC --> DB
  API --> SEL --> DB
Loading

ER Diagram (полный проект)

Примечания:

  • CartItem и OrderItem: либо product_id, либо ticket_type_id (зависит от item_type).
  • EventLocation используется для offline, EventOnlineInfo — для online (обычно одна из связей).
erDiagram
    %% =========================
    %% ACCOUNTS
    %% =========================
    USER {
      int id PK
      string email "unique"
      string password_hash
      string first_name
      string last_name
      string phone "nullable"
      boolean is_active
      datetime date_joined
      datetime created_at
      datetime updated_at
    }

    SOCIAL_ACCOUNT {
      int id PK
      int user_id FK
      string provider
      string provider_user_id
      json extra_data
      datetime created_at
    }

    ORGANIZER_PROFILE {
      int id PK
      int user_id FK "unique"
      string display_name
      string bio "nullable"
      string city "nullable"
      string instagram "nullable"
      boolean verified
      datetime created_at
      datetime updated_at
    }

    %% =========================
    %% EVENTS
    %% =========================
    EVENT {
      int id PK
      int organizer_id FK
      string title
      text description
      string sport_type "nullable"
      string format "online|offline"
      string status "draft|published|finished|canceled"
      datetime start_datetime
      datetime end_datetime "nullable"
      boolean is_free
      string cover_image "nullable"
      datetime created_at
      datetime updated_at
    }

    EVENT_LOCATION {
      int id PK
      int event_id FK "unique"
      string country
      string city
      string address
      string map_url "nullable"
      float latitude "nullable"
      float longitude "nullable"
      datetime created_at
      datetime updated_at
    }

    EVENT_ONLINE_INFO {
      int id PK
      int event_id FK "unique"
      string stream_url "nullable"
      string meeting_link "nullable"
      text access_instructions "nullable"
      datetime created_at
      datetime updated_at
    }

    TICKET_TYPE {
      int id PK
      int event_id FK
      string name
      decimal price
      string currency "KZT"
      int quantity_total
      int quantity_sold
      datetime sales_start "nullable"
      datetime sales_end "nullable"
      datetime created_at
      datetime updated_at
    }

    EVENT_ATTENDEE {
      int id PK
      int user_id FK
      int ticket_type_id FK
      int order_item_id FK "nullable"
      string status "reserved|paid|canceled|refunded|checked_in"
      string qr_code "nullable"
      datetime created_at
      datetime updated_at
    }

    %% =========================
    %% MARKET
    %% =========================
    CATEGORY {
      int id PK
      string name
      string slug "unique"
      int parent_id FK "nullable"
      datetime created_at
      datetime updated_at
    }

    PRODUCT {
      int id PK
      int organizer_id FK
      int category_id FK "nullable"
      string title
      text description
      decimal price
      string currency "KZT"
      int stock_quantity
      boolean is_active
      datetime created_at
      datetime updated_at
    }

    PRODUCT_IMAGE {
      int id PK
      int product_id FK
      string image_url
      boolean is_main
      datetime created_at
    }

    %% =========================
    %% ORDERS
    %% =========================
    CART {
      int id PK
      int user_id FK "unique"
      datetime created_at
      datetime updated_at
    }

    CART_ITEM {
      int id PK
      int cart_id FK
      string item_type "product|ticket"
      int product_id FK "nullable"
      int ticket_type_id FK "nullable"
      int quantity
      decimal unit_price
      datetime created_at
      datetime updated_at
    }

    ORDERS_ORDER {
      int id PK
      int user_id FK
      string order_number "unique"
      string status "new|pending_payment|paid|canceled|refunded|shipped|completed"
      decimal total_amount
      string currency "KZT"
      string payment_status "unpaid|paid|refunded"
      string delivery_type "none|pickup|delivery"
      datetime created_at
      datetime updated_at
    }

    ORDER_ITEM {
      int id PK
      int order_id FK
      string item_type "product|ticket"
      int product_id FK "nullable"
      int ticket_type_id FK "nullable"
      int quantity
      decimal unit_price
      decimal total_price
      datetime created_at
      datetime updated_at
    }

    SHIPPING_ADDRESS {
      int id PK
      int order_id FK "unique"
      string country
      string city
      string address_line
      string postal_code "nullable"
      string recipient_name
      string recipient_phone
      datetime created_at
      datetime updated_at
    }

    %% =========================
    %% PAYMENTS
    %% =========================
    PAYMENT {
      int id PK
      int order_id FK
      string provider "kaspi|paybox|cloudpayments|mock"
      string status "initiated|succeeded|failed|refunded"
      decimal amount
      string currency "KZT"
      string provider_payment_id "nullable"
      datetime paid_at "nullable"
      datetime created_at
      datetime updated_at
    }

    REFUND {
      int id PK
      int payment_id FK
      decimal amount
      string status "initiated|succeeded|failed"
      datetime created_at
      datetime updated_at
    }

    %% =========================
    %% CRM
    %% =========================
    CUSTOMER_NOTE {
      int id PK
      int organizer_id FK
      int user_id FK
      text note_text
      datetime created_at
      datetime updated_at
    }

    CRM_TASK {
      int id PK
      int organizer_id FK
      string title
      text description "nullable"
      datetime due_date "nullable"
      string status "todo|in_progress|done"
      datetime created_at
      datetime updated_at
    }

    %% =========================
    %% RELATIONSHIPS
    %% =========================
    USER ||--o| ORGANIZER_PROFILE : has
    USER ||--o{ SOCIAL_ACCOUNT : connects

    ORGANIZER_PROFILE ||--o{ EVENT : creates
    EVENT ||--o| EVENT_LOCATION : has
    EVENT ||--o| EVENT_ONLINE_INFO : has
    EVENT ||--o{ TICKET_TYPE : offers
    TICKET_TYPE ||--o{ EVENT_ATTENDEE : sold_to
    USER ||--o{ EVENT_ATTENDEE : buys

    CATEGORY ||--o{ CATEGORY : parent_of
    ORGANIZER_PROFILE ||--o{ PRODUCT : sells
    CATEGORY ||--o{ PRODUCT : categorizes
    PRODUCT ||--o{ PRODUCT_IMAGE : has

    USER ||--o| CART : owns
    CART ||--o{ CART_ITEM : contains
    PRODUCT ||--o{ CART_ITEM : in_cart
    TICKET_TYPE ||--o{ CART_ITEM : in_cart

    USER ||--o{ ORDERS_ORDER : places
    ORDERS_ORDER ||--o{ ORDER_ITEM : contains
    PRODUCT ||--o{ ORDER_ITEM : ordered
    TICKET_TYPE ||--o{ ORDER_ITEM : ordered
    ORDERS_ORDER ||--o| SHIPPING_ADDRESS : ships_to

    ORDERS_ORDER ||--o{ PAYMENT : paid_by
    PAYMENT ||--o{ REFUND : refunds

    ORGANIZER_PROFILE ||--o{ CUSTOMER_NOTE : notes
    USER ||--o{ CUSTOMER_NOTE : is_subject
    ORGANIZER_PROFILE ||--o{ CRM_TASK : plans
Loading

🗓️ 15-Week Development Roadmap

Goal: Ship a full-featured SportHub marketplace — events, tickets, products, cart, payments and CRM — from scratch to live demo.

# Theme What to do Key API / Artifact
1 📋 Planning Roles, GitHub repo, ER-diagram, README docs/er_diagram.png
2 🐳 Infra docker-compose (Postgres + Django + React), .env GET /api/health/
3 🗄️ DB + Models Models: User, OrganizerProfile, Event, TicketType, Product, Category, Cart, Order, OrderItem, Payment + migrations Django ORM, makemigrations
4 🔐 Auth — JWT Register, login, refresh, /auth/me/ POST /auth/register/ · POST /auth/login/ · GET /auth/me/
5 👥 Auth — Roles + OAuth OrganizerProfile, Google OAuth, guard /crm/* POST /auth/organizer/ · POST /auth/token/refresh/
6 🎟️ Events + Tickets CRUD events (organizer), public list, tickets GET/POST /events/ · GET /events/{id}/tickets/ · PATCH /crm/events/{id}/ · POST /crm/events/{id}/publish/
7 🛍️ Products + Cart CRUD products (organizer), catalog, add to cart GET/POST /products/ · POST /cart/items/ · PATCH /cart/items/{id}/ · DELETE /cart/items/{id}/
8 📦 Orders + Checkout Cart → place order (Order + OrderItems from cart) GET /cart/ · POST /orders/ · GET /orders/{id}/
9 💳 Payments Mock charge → status paid, update Order POST /payments/mock/charge/
10 📊 CRM — Events & Products Manage organizer events and products GET/POST /crm/events/ · GET/POST /crm/products/ · GET /crm/dashboard/
11 👤 CRM — Orders & Customers Order list, status change, customer notes GET /crm/orders/ · PATCH /crm/orders/{id}/ · POST /crm/customers/{id}/notes/
12 ⚙️ CI/CD + Tests GitHub Actions (lint + build + pytest), coverage ≥ 40% .github/workflows/ci.yml
13 🔥 Load Testing k6 scripts: 100 VU on /events/, checkout flow, /auth/login/ Report: RPS + p95 Latency
14 📈 Monitoring + Deploy Prometheus + Grafana, seed_db (10 events, 50 products), docker-compose.prod.yml GET /metrics/ · Grafana dashboard
15 🎉 Demo Day Live demo: register → order → pay → CRM Swagger UI + k6 under load

Progress Tracker

  • Week 1 — Planning
  • Week 2 — Infra
  • Week 3 — DB + Models
  • Week 4 — Auth JWT
  • Week 5 — Auth Roles + OAuth
  • Week 6 — Events + Tickets
  • Week 7 — Products + Cart
  • Week 8 — Orders + Checkout
  • Week 9 — Payments
  • Week 10 — CRM Events & Products
  • Week 11 — CRM Orders & Customers
  • Week 12 — CI/CD + Tests
  • Week 13 — Load Testing
  • Week 14 — Monitoring + Deploy
  • Week 15 — Demo Day

License

MIT License

About

No description, website, or topics provided.

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

 
 
 

Contributors

Languages