How city-of-vantaa-smartlab/mobiilinutakortti works
Main Components
a. Client Layer:
• Frontend (React, Port 3001) - Youth user interface
• Admin Frontend (React Admin, Port 3002) - Youth worker interface
b. API Layer:
• Backend (NestJS, Port 3000)
• API endpoints categorization:
• Authentication endpoints
• Youth management endpoints
• Club management endpoints
• QR code handling endpoints
• Extra entries endpoints
c. External Services:
• Telia SMS Service
• Amazon Email Service
• Microsoft Entra ID (optional authentication)
• Suomi.fi identification
d. Database Layer:
• PostgreSQL (Port 5432)
• Key entities to highlight:
• Juniors (youth)
• Youth Workers
• Clubs
• Check-ins
• Extra Entries
• Announcements
Component Relationships
• Frontend → Backend (REST API calls)
• Admin Frontend → Backend (REST API calls)
• Backend → External Services (SMS, Email, Authentication)
• Backend → Database (Data persistence)
Additional Elements
A section showing:
• Environment configurations
• Port mappings
• Docker container boundaries
• Key security boundaries
Notes Section
Notes about:
• Scalability considerations
• Security implementations
• External service dependencies
• Environment-specific configurations
Remember to emphasize the security aspects, especially around the QR code system and youth worker authentication, as these are critical features of the application.
This system design should help developers understand both the overall architecture and the specific implementation details needed for maintenance and further development.