How djandres04/backend1 works
Project type and purpose
• This is a single-service backend written in Python using Flask. Its primary role is to expose REST endpoints (Home, Devices, Door, Light, Temperature), handle authentication via JWT, perform business logic, interact with a database, and return JSON messages.
File structure
• Top-level:
• .dockerignore, requirements.txt, README.md
• src/ – all application code
• src/ contains:
• app.py – Flask application entry point
• config.py – reads environment variables (SECRET_KEY, JWT_KEY, DB_* variables, SERVER_REST)
• database/db.py – database connection and session management
• models/ – ORM models and entity definitions (ModelDevices, ModelUser, entities/User)
• routes/ – route handlers, one module per resource (DevicesRoute, DoorRoute, HomeRoute, LightRoute, TemperatureRoute)
• utils/ – cross-cutting utilities (AuthenticateJWT, ConverterTime, Encrypt, JsonMessage, token)
README for additional insights
• Describes installation, environment variables, Python/Flask versions.
a. Main components
1. External Clients – any consumer (web/mobile/IoT dashboards, curl/Postman)
2. Flask Application
– app.py and config.py initialize server and load env vars
3. API Layer (Routes)
– route modules map HTTP verbs and paths to controller logic
4. Authentication Middleware
– AuthenticateJWT utility intercepts protected routes
5. Business Logic / Services
– Model classes (ModelDevices, ModelUser) orchestrate operations
– ConverterTime, Encrypt, token, JsonMessage utilities
6. Data Layer
– database/db.py manages engine, sessions
– ORM entities in models/entities
7. Persistence Store
– External database (hosted per DB_HOST, DB_PORT, etc.)
b. Relationships and interactions
• External Client → HTTP request → Flask app
• Flask app loads config → dispatches to Routes
• Route entry → (optional) Authentication via AuthenticateJWT → passes user context
• Route handler calls Model* classes + utils
• Model layer uses database/db.py session to query or persist ORM entities
• Utilities (Encrypt, ConverterTime, token, JsonMessage) support data transformation, token generation, payload formatting
• Model returns result → Route formats JSON response → Flask returns HTTP response to client
c. Architectural patterns and design principles
• Layered architecture: Presentation (API/Routes), Business (Models + Utils), Data Access (db.py + Entities), Config
• Separation of concerns: each directory focuses on one responsibility
• Stateless JWT authentication
• Dependency injection of configuration via environment variables
• Modularization by resource (one route file per domain object)
d. Key technologies
• Python 3.8+, Flask 1.1.2+
• JWT for auth (AuthenticateJWT, token utils)
• SQLAlchemy or similar ORM in database/db.py (inferred)
• Custom utilities for encryption, time conversion, JSON message formatting
Detail
• Config.py feeding secrets/DB settings into Flask app at startup.
• Utilities as shared services connected to the business layer.
• Entire request-response cycle, from HTTP entry to DB transaction to JSON response.