How sanjay004mk/travel-tracker works
Project type and purpose
• This is a full-stack web application (“Path Finder: A Trip & Expense Manager”) consisting of:
• A React single-page application (Material-Tailwind, Vite)
• A Node.js/Express REST API
• A MongoDB database
• Containerization via Docker Compose
• CI/CD via Jenkins
File structure
• Top-level:
• backend/ – Express app, database models, routes, tests, Dockerfile, env
• frontend/ – React app (src/, public/, layouts, pages, widgets), configs, Dockerfile, env
• docker-compose.yml & docker-test.yml – multi-container definitions
• README.md – project overview, tech stack, deployment, testing, CI/CD
• backend/DETAILS:
• database/ – Mongoose connection and schema files (user.js, trip.js, expense.js) + tests
• routes/ – Express routers by resource (user-records.js, trip-records.js, etc.)
• server.js & app.js – Express app setup, middleware (require-middleware.js)
• frontend/DETAILS:
• src/ – main.jsx, App.jsx, React contexts, API util, page components, reusable widgets (cards, charts, layout)
• public/ – static assets, index.html
• configurations – jsconfig, postcss, tailwind, vite, prettier
README for additional insights
• Architectural notes: JWT auth with secure cookies, bcryptjs hashing
• Docker Compose brings up three services: frontend, backend, MongoDB
• docker-test.yml for containerized tests
• CI/CD pipeline in Jenkinsfile runs docker-compose → build → test
a. Frontend SPA (React/Vite)
• Serves UI, communicates over HTTP(S)
• Hosts Material Tailwind UI + Recharts
b. Backend API (Node/Express)
• Authentication layer (JWT issuance & verification via require-middleware)
• Business logic in routes (users, trips, expenses, metrics)
• Database access via Mongoose models (User, Trip, Expense)
c. MongoDB
• Persistent storage for users, trips, expenses, activity notes
d. External Services & DevOps
• Docker Compose orchestrator
• Jenkins CI pipeline
• (Optional) Vercel hosting for frontend – vercel.json
Relationships & dataflow
• Frontend → (HTTP REST) → Backend
• Backend → (Mongoose) → MongoDB
• JWT flows: upon login, API issues token → client stores in secure cookie → subsequent API calls include token
• Docker Compose ties together frontend, backend, MongoDB on a private network
• Jenkins triggers Docker Compose → builds images → runs tests against backend container
Architectural patterns & design principles
• MVC-style separation in backend:
• Models (database/)
• Routes/Controllers (routes/)
• Middleware (require-middleware.js)
• React component hierarchy / Atomic design in frontend:
• Pages → Layouts → Widgets → UI elements
• Containerization for environment parity
• Layered security with JWT & secure cookies
• Test-driven development with Vitest (unit & integration)
• Frontend: React app, API util
• Backend: Express server, route modules, auth middleware, Mongoose models
• Database: MongoDB
• Container layer: Docker Compose grouping
• DevOps: Jenkins (CI/CD)
• Security flow: JWT token issuance & verification