How devmhrn/imf_gadgetapi works
Project Type & Purpose
• Full-stack web application:
– Backend: Secure REST API managing covert gadgets
– Frontend: Single-Page App for agents/handlers/admins
• Mission: CRUD + emergency self-destruct on gadgets, JWT auth, role-based access.
File Structure & Architectural Patterns
• backend/
– app.js: entry point, Express server setup
– config/: DB & environment config
– controllers/: request handlers (auth, gadget) → MVC “C” layer
– models/: Sequelize ORM entities → “M” layer
– routes/: URL → controller bindings
– middlewares/: auth, error handling, rate limiting
– services/: internal logic (codename generator)
– utils/: logging
– DockerFile + docker-compose.yml → containerization
• frontend/
– Vite + React + Tailwind CSS
– src/pages/: routable views (login, dashboard)
– src/components/: UI widgets
– src/libs/apiCalls.js: API wrapper
– src/libs/firebaseConfig.js: integrates Firebase Auth
– src/store/: client-side state management
Pattern:
• Backend follows MVC + Service pattern
• Frontend follows component-based SPA with API layer
README for Extra Context
• External services: Firebase Authentication for login
• Database: PostgreSQL (Sequelize ORM)
• Security: AES-256 JWT tokens, bcrypt, role enforcement
• Deployment: Docker + docker-compose
Main Components & Their Interactions
A. Components
1. Frontend SPA (React/Vite)
2. Firebase Auth (external service)
3. Backend API (Express/Node)
• Auth Module (login, JWT issuance/validation)
• Gadget Module (controllers, services, routes)
• Database Access (Sequelize)
4. PostgreSQL Database
5. Internal Service: Codename generator
B. Data Flows & Relationships
1. User → Frontend UI (login, gadget management)
2. Frontend → Firebase: obtain firebaseToken
3. Frontend → Backend /api/auth/login: send firebaseToken
4. Backend → Firebase: verify token → create internal JWT
5. Frontend attaches JWT to subsequent REST calls (/api/gadgets…)
6. Backend → PostgreSQL: read/write gadget & user tables
7. Backend Service: generate random codename and success probability
C. Architectural Patterns
• MVC + Service Layer in backend
• Client-side API wrapper + state store in frontend
• Layered security: Firebase → internal JWT → RBAC
D. Key Technologies
• Node.js, Express, Sequelize, PostgreSQL
• JWT, bcrypt, AES-256 (via jwt library)
• React, Vite, Tailwind CSS
• Firebase Authentication