How otniel113/tokotniel works
Project type & purpose (what you’re diagramming)
This is a backend-only REST API for a digital wallet. It exposes endpoints for:
• Auth (registration/login) using JWT
• Service catalog (list services/tariffs)
• Transactions (balance, top-up, purchase)
It runs on Node.js + Express, persists to MySQL, and publishes interactive docs via Swagger UI (/api-docs). It’s deployed (Render) as a single web service.
Architecture inferred from file tree (how it’s structured)
From the tree, this is a classic layered Express app:
Entry / Composition root
• server.js – process entrypoint (starts HTTP server, probably loads env, binds Express)
• src/app.js – Express app composition (middleware, routes, swagger)
Configuration / cross-cutting
• src/config/db.js – DB connection/pool to MySQL
• src/config/swagger.js – Swagger setup
Routing (HTTP interface)
• src/routes/authRoutes.js
• src/routes/serviceRoutes.js
• src/routes/transactionRoutes.js
Controllers (request handlers / orchestration)
• src/controllers/authController.js
• src/controllers/serviceController.js
• src/controllers/transactionController.js
Middleware (cross-cutting request pipeline)
• src/middleware/authMiddleware.js – JWT verification / request authorization
Data access / domain representation
• src/models/User.js
• src/models/Service.js
• src/models/Transaction.js
Utilities
• src/utils/validation.js – request validation rules/helpers
• src/utils/invoice.js – likely generates invoice/receipt data for transactions
API documentation definitions
• src/views/*Docs.js – Swagger definitions (paths/schemas grouped per module)
Database schema
Architecturally, it’s a modular monolith (single service) with modules split by feature area.
What to include from README (system boundaries & interactions)
Key externally visible parts:
• REST endpoints listed in README
• JWT auth (clients must pass token to protected endpoints)
• Swagger UI is part of the service
• MySQL is the persistence boundary
• Deployment: hosted on Render (so there’s an infra node: Render service + MySQL host)
Client → Express Routes
• POST /registration → authRoutes → authController
• POST /login → authRoutes → authController → returns JWT
Protected endpoints flow
• Client includes Authorization: Bearer <token>
• Request passes through authMiddleware.js:
• verifies JWT using secret from .env
• on success attaches user context to request
• Then hits controller:
• /services → serviceController
• /balance, /topup, /transaction → transactionController
Controllers → Models → MySQL
• Controller calls relevant Model methods (User/Service/Transaction)
• Model queries MySQL via src/config/db.js connection/pool
Controllers → Utils
• Validation utilities applied before or inside controllers (utils/validation.js)
• Invoice/receipt generation after successful purchase (utils/invoice.js) (if used)
Swagger UI
• Browser → GET /api-docs served by Express using swagger.js
• swagger.js pulls in definitions from src/views/*Docs.js
Important patterns to highlight
• Layered architecture: Routes → Middleware → Controllers → Models → DB
• Feature-based modularization: auth / services / transactions separated across routes/controllers/docs
• JWT-based stateless auth: no session store; token verification at middleware
• Central DB config: single connection/pool reused
• Node.js, Express
• JWT
• MySQL
• Swagger UI / OpenAPI
• Render (deployment target)
• Environment variables (.env) as secret/config source
• server.js (bootstrap)
• src/app.js (Express app wiring)
• src/config/db.js (MySQL connection/pool)
• src/config/swagger.js (OpenAPI assembly)
• src/routes/authRoutes.js
• src/routes/serviceRoutes.js
• src/routes/transactionRoutes.js
• src/middleware/authMiddleware.js
• src/controllers/authController.js
• src/controllers/serviceController.js
• src/controllers/transactionController.js
• src/models/User.js
• src/models/Service.js
• src/models/Transaction.js
• src/utils/validation.js
• src/utils/invoice.js
• src/views/authDocs.js
• src/views/serviceDocs.js
• src/views/transactionDocs.js
• .env (config/secrets)
• DDL.sql (schema source-of-truth)