How tyball21/open-hams works
Main System Components
A. Frontend Layer (React/Vite Application)
• User Interface Components
• State Management
• API Integration Layer
• Authentication/Authorization
B. Backend Layer (FastAPI)
• API Routes
• Business Logic
• Authentication/Security
• Database Access Layer
C. Database Layer (MySQL)
• Data Storage
• Migrations (Alembic)
D. External Services
• Email Service (hams-mails)
Component Relationships and Details
Frontend Section:
• Dashboard Components
• Authentication Routes
• Event Management
• Animal Management
• User Management
• API Integration Layer
• UI Components Library
Backend Section:
• API Routes (/api/routes/)
• Core Services (core/)
• Database Models (db/)
• Authentication/Security
• Migration System (Alembic)
Database Section:
• Animals
• Events
• Users
• Groups
• Roles
• Permissions
Interaction Flows
• Frontend to Backend API calls
• Backend to Database interactions
• Authentication flows
• Email service integration
Specific Implementation Details
Technical stack badges:
• React/Vite
• FastAPI
• MySQL
• Tailwind CSS
• SQLAlchemy
• Pydantic
Key Features to Highlight
Specific flows for:
• Animal check-in/check-out system
• Multi-user management
• Department management
• Data export functionality
• Activity feed system
Security Layer
Highlight:
• JWT authentication
• Role-based access control
• Password reset flow
• Security middleware
For this specific project, emphasize the animal management workflows and multi-user aspects, as these are core features of the system. Also highlight the scalability aspects of the SaaS architecture, as this is designed to be self-hosted by different organizations.