How ivankomorales/haro-mobile works
Project type and purpose
• This is a RESTful backend API for managing personalized ceramic orders (orders, customers, glazes, users).
• It exposes CRUD endpoints secured by JWT and role-based middleware.
• It uses Node.js/Express on the server side and MongoDB (via Mongoose) for persistence.
File structure
• app.js: boots the Express server, loads middleware, mounts routes.
• config/db.js: establishes MongoDB connection.
• routes/*: define HTTP endpoints (auth, user, order, glaze).
• middleware/*: JWT verification, role checks.
• controllers/*: business logic for each resource, orchestrating model operations.
• models/*: Mongoose schemas (User, Customer, Order, Glaze, Counter).
• package.json: lists dependencies (express, mongoose, dotenv, helmet, cors, morgan, jsonwebtoken).
README for additional insights
• Uses Helmet, CORS, Morgan for security/logging.
• Auth with JWT; admin role guards destructive operations.
• Auto-incrementing orderID via Counter collection.
• Future integration target: React PWA client.
Main components
a. Clients
• External client (Postman or future React PWA)
b. API Server
• Express.js application
• dotenv for config
• Global middleware (helmet, cors, morgan)
• Auth middleware (verifyToken, checkRole)
• Route handlers (authRoutes, userRoutes, orderRoutes, glazeRoutes)
• Controllers for business logic
• Mongoose models/data access layer
c. Database
• MongoDB Atlas or local instance
• Collections: users, customers, orders, glazes, counters
d. External services (future/file storage, PDF/Excel exporter)
Relationships and data flow
1. Client → HTTP Request → Express Router
2. Router → Middleware chain (security, JWT verify, role check)
3. Middleware → Controller method
4. Controller → Mongoose Model operations (CRUD)
5. Model → MongoDB read/write
6. Response travels back through Controller → Middleware → Router → Client
Architectural patterns and design principles
• Layered architecture: Presentation (routes) → Business (controllers) → Data (models).
• Separation of concerns: security in middleware, business rules in controllers, schema logic in models.
• Configuration via dotenv keeps environment-specific details out of code.
• Atomic orderID generation with a Counter collection for sequential IDs.
Technologies, frameworks, libraries
• Node.js, Express.js
• MongoDB, Mongoose
• dotenv, helmet, cors, morgan
• JSON Web Tokens for authentication
• Postman (for testing)
• Future: React PWA client