73a17aaf9a
Full project scaffold for TapTrack Hub — cloud SaaS control plane for managing on-prem TapTrack school deployments. ## Infrastructure - Docker Compose: backend (gunicorn+uvicorn), Celery worker + beat, frontend (Vite build + nginx), PostgreSQL 15, Redis 7, nginx proxy - Dockerfile for backend and frontend, nginx reverse proxy config ## Backend (FastAPI + SQLAlchemy async + Celery) Database schema (10 tables): hub_users, schools, licenses, sms_jobs, sms_credit_ledger, invoices, invoice_line_items, school_subscriptions, support_tickets, ticket_replies, audit_logs, announcements Auth: JWT (python-jose) + bcrypt + role-based FastAPI dependencies (get_current_user, require_super_admin, require_school_admin) Routers (11): auth, schools, licenses, sms, billing, tickets, users, dashboard, school_portal, announcements, sync Celery tasks (6): sms.process_queue, billing.generate_monthly_invoices, billing.send_invoice_email, billing.check_overdue, license.check_expiry, reports.send_monthly_reports Services: SMTP email helper (smtplib + Jinja2) Seed script: creates super admin admin@taptrack.io ## Frontend (Vue 3 + Vite + Pinia + Tailwind CSS) Router: 14 routes across super admin + school portal layouts Stores: Pinia auth store with localStorage persistence API client: full axios client for all backend endpoints Layouts: AppLayout (super admin), PortalLayout (school), AuthLayout Components: AppSidebar, PortalSidebar, SidebarItem, KpiCard, StatusBadge, ToastStack Pages: Login, Dashboard, Schools, SchoolDetail, Licenses, SMS, Billing, Tickets, TicketDetail, Users, Announcements, 404 Portal pages: Overview, Billing, SMS Reports, Tickets, Profile ## PAUL Planning Files - .paul/ROADMAP.md: full 15-phase roadmap with detailed scope - .paul/STATE.md: current position, tech stack, architecture notes - .paul/phases/01-setup/01-PLAN.md: complete Phase 1 plan (done) - .paul/phases/02 through 15: README stubs for all future phases
46 lines
2.5 KiB
Python
46 lines
2.5 KiB
Python
import uuid
|
|
import enum
|
|
from datetime import datetime, timezone
|
|
from sqlalchemy import String, Boolean, DateTime, Enum as SAEnum, Text, Numeric, Integer
|
|
from sqlalchemy.orm import Mapped, mapped_column, relationship
|
|
from app.database import Base
|
|
|
|
class SchoolStatus(str, enum.Enum):
|
|
active = "active"
|
|
suspended = "suspended"
|
|
expired = "expired"
|
|
pending = "pending"
|
|
|
|
class LicenseTier(str, enum.Enum):
|
|
basic = "basic"
|
|
standard = "standard"
|
|
premium = "premium"
|
|
|
|
class School(Base):
|
|
__tablename__ = "schools"
|
|
|
|
id: Mapped[str] = mapped_column(String(36), primary_key=True, default=lambda: str(uuid.uuid4()))
|
|
name: Mapped[str] = mapped_column(String(255), nullable=False)
|
|
slug: Mapped[str] = mapped_column(String(100), unique=True, nullable=False, index=True)
|
|
address: Mapped[str | None] = mapped_column(Text, nullable=True)
|
|
city: Mapped[str | None] = mapped_column(String(100), nullable=True)
|
|
contact_name: Mapped[str | None] = mapped_column(String(255), nullable=True)
|
|
contact_email: Mapped[str | None] = mapped_column(String(255), nullable=True)
|
|
contact_phone: Mapped[str | None] = mapped_column(String(50), nullable=True)
|
|
billing_email: Mapped[str | None] = mapped_column(String(255), nullable=True)
|
|
status: Mapped[SchoolStatus] = mapped_column(SAEnum(SchoolStatus), default=SchoolStatus.pending, nullable=False)
|
|
tier: Mapped[LicenseTier] = mapped_column(SAEnum(LicenseTier), default=LicenseTier.standard, nullable=False)
|
|
student_limit: Mapped[int] = mapped_column(Integer, default=500, nullable=False)
|
|
sms_sender_name: Mapped[str] = mapped_column(String(11), default="SCHOOL", nullable=False)
|
|
sms_credits: Mapped[float] = mapped_column(Numeric(12, 2), default=0.0, nullable=False)
|
|
sms_credit_low_threshold: Mapped[int] = mapped_column(Integer, default=50, nullable=False)
|
|
created_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=lambda: datetime.now(timezone.utc))
|
|
notes: Mapped[str | None] = mapped_column(Text, nullable=True)
|
|
|
|
admins: Mapped[list["HubUser"]] = relationship("HubUser", back_populates="school")
|
|
license: Mapped["License | None"] = relationship("License", back_populates="school", uselist=False)
|
|
sms_jobs: Mapped[list["SmsJob"]] = relationship("SmsJob", back_populates="school")
|
|
invoices: Mapped[list["Invoice"]] = relationship("Invoice", back_populates="school")
|
|
tickets: Mapped[list["SupportTicket"]] = relationship("SupportTicket", back_populates="school")
|
|
audit_logs: Mapped[list["AuditLog"]] = relationship("AuditLog", back_populates="school")
|