How srajasimman/mern-assessment-app works
Project type and purpose
• This is a full-stack MERN (MongoDB, Express, React, Node.js) web application—a customizable online assessment platform.
• Frontend (“client/”): React + TypeScript + Material UI SPA that administrators and responders use.
• Backend (“server/”): Node.js + Express REST API with Mongoose models exposing endpoints for assessments and responses.
• Database: MongoDB for persisting assessments and responses.
• Deployment: Docker (dev & prod), Nginx for serving static assets and proxying API.
File structure
Top level
• client/ – React app with Dockerfiles (dev/prod), nginx.conf for production, source under src/, services/api.ts for HTTP calls.
• server/ – Express app split into config, controllers, models, middleware, routes, with dev/prod Dockerfiles.
• docker-compose.dev.yml & docker-compose.prod.yml – multi-container setups for dev and prod (client, server, Mongo).
• CI/CD – .github/workflows for build/test pipelines.
• deploy-prod.sh, docker-bake.hcl – scripts for building and pushing production images.
README for additional insights
• Confirms MERN stack, React Router v6, Axios, Mongoose.
• Describes API endpoints, environment variables, commands for dev/prod.
• Future enhancements hint at JWT auth, analytics, etc.
a. Main components
• User Devices (Browsers)
• Frontend SPA (React)
• Reverse Proxy / Static Server (Nginx in prod)
• Backend REST API (Node/Express)
• Database (MongoDB)
• (Optionally) CI/CD pipeline (GitHub Actions)
b. Relationships & interactions
1. User interacts with React SPA served by Nginx (prod) or webpack‐dev server (dev).
2. SPA issues HTTP(S) calls via Axios to Express API endpoints (/api/assessments, /api/responses).
3. Express controllers invoke Mongoose models to read/write documents in MongoDB.
4. Responses flow back to SPA which updates UI.
5. In production, image builds and pushes occur via deploy-prod.sh and docker-bake; CI runs tests on push/PR.
c. Architectural patterns and principles
• Separation of concerns: UI layer vs. API layer vs. data layer.
• MVC‐esque structure in backend: controllers ↔ models ↔ routes.
• Componentized React UI in client/src/components.
• Environment‐specific Docker configurations.
d. Key technologies
• React + TypeScript, Material UI, React Router, Axios
• Node.js, Express.js, Mongoose, MongoDB
• Docker, Docker Compose (dev & prod), Nginx (static + proxy)
• GitHub Actions CI