How sws2apps/sws2apps-api works
Project type and purpose
• This is a backend‐only, full-stack API service written in TypeScript (Node.js) using Express-style routing.
• Purpose: expose endpoints for the “Scheduling Workbox System” family of applications (sws2apps), handle authentication, business logic, localization, and persistence in Firebase (Firestore & Storage), plus send localized email notifications.
File structure
• Top level directories:
• src/ – all application code
• src/v3/routes/ – Express routes definitions
• src/v3/controllers/ – controllers implement request handlers
• src/v3/services/ – service layer broken down by responsibility (API adapters, Firebase data access, encryption, iP lookups, etc.)
• src/v3/middleware/ – reusable middleware (auth checks, version checks, request validation)
• src/v3/config/ – environment-specific configurations (DB, Firebase, i18n, mail)
• src/v3/classes/ & src/v3/definition/ – domain models and TypeScript definitions
• src/v3/utils/ – helper functions
• src/v3/views/ – Handlebars templates for email notifications
• Configuration & infra:
• firebase.json, .firebaserc.example – Firebase hosting/emulator settings
• .devcontainer, .github/workflows – dev & CI/CD setup
• crowdin.yml & locales/ – localization pipeline
README for additional insights
• Confirms the service is the backend for all sws2apps apps
• Emphasizes email localization via Crowdin
Essential elements
• Do not overcrowd with file names; instead group by module/function
• Cross-cutting middleware (auth, version check, request validation)
• How localization files (locales/) feed into i18n_config → email templates