How gbmatheus/schedule-service works
Project type and purpose
• This is a backend RESTful API for a “Medical Appointments” system. It exposes endpoints for doctors, patients, user authentication, and session management. It uses Node.js with Express, Sequelize ORM, JWT‐based authentication, and a relational database (e.g., PostgreSQL).
File structure
• Top-level artifacts:
• docker-compose.yaml & Procfile for containerization/deployment
• .env.example for environment variables
• package.json for dependencies & scripts
• src/config: holds database and auth configuration
• src/routes: defines HTTP routes by domain (doctor, patient, user, session)
• src/controllers: maps routes to actions
• src/services: business logic (CreateDoctorService, AuthenticationUserService, etc.)
• src/models & src/database (migrations): Sequelize models and DB setup
• src/middlewares: JWT verification middleware
Extract additional insights from README
• JWT for authentication/authorization
• Sequelize for DB migrations & ORM
• Typical MVC‐style layering (Routes → Controllers → Services → Models)
Main components
a. External Clients
• Web/Mobile clients or API consumers (e.g., front‐end apps, Postman)
b. API Layer (Node.js/Express)
• Entry point: server.js (Express app)
• Routes → Middlewares (verifyAuth) → Controllers → Services → ORM
c. Database
• PostgreSQL (via Sequelize)
• Migration scripts & connection pooling
d. Configuration / Environment
• JWT secret, DB connection strings (from .env)
e. Deployment & Infrastructure
• Docker container, docker‐compose orchestration or Heroku Procfile setup
Relationships & data flow
• Client sends HTTP request → Load Balancer (if present) → Dockerized Express server
• Express router matches route → verifyAuth middleware (if protected) → relevant Controller
• Controller invokes Service to implement business logic → Service interacts with Sequelize Models
• Sequelize communicates with the Database, returning data to the Service → Controller formats response → Express returns JSON to Client
Architectural patterns & design principles
• Layered architecture (Router → Controller → Service → Model)
• Separation of concerns:
• Authentication isolated in auth config & middleware
• Business logic in “services” dir
• Data access in “models” & “database”
• Configurable via environment variables for 12-factor compliance
Technologies & frameworks to annotate
• Node.js + Express (API server)
• Sequelize ORM + PostgreSQL (Data layer)
• JWT (Authentication)
• Docker / docker‐compose (Containerization)
• dotenv (.env management)