How mohammedaldaw/expense-tracker works
Project type and purpose
• This is a full-stack RESTful web application (“Expense Tracker”) for tracking daily expenses and revenues.
• Built with Node.js/Express on the backend, MongoDB for persistence, Handlebars for server-side rendering, and client-side JavaScript (Chart.js) for visualization.
• Supports local authentication and OAuth (Facebook, Google).
File structure
• Top-level entry point: app.js
• Configuration: config/mongoose.js (DB), config/passport.js (auth strategies)
• Routes: routes/index.js delegates to module routers in routes/modules (auth, home, records, users)
• Controllers: controllers/*Controller.js contain request handlers
• Models: models/*.js define Mongoose schemas; models/seeds provide JSON and seed scripts
• Middleware: middleware/auth.js guards protected routes
• Views: views/ directory with hbs templates (layouts, partials, pages)
• Public: static assets (stylesheets, client-side JS, images)
• Utils: handlebars helper, record-processing utilities
• Procfile and .env.example indicate deployment on Heroku with env vars.
README
• Describes features (sign up, login, CRUD on expenses, charting, budget alerts)
• Mentions technical stack (Node, Express, MongoDB), seed script, OAuth setup.
• Live demo and credentials for testing.
a. Main components:
• Client (Browser/mobile): renders HBS views, fetches data, visualizes charts via Chart.js
• Web Server (Node.js/Express):
• Router layer (routes/modules/*.js)
• Auth middleware (passport + custom auth.js)
• Controllers (handle CRUD, business logic, calls to utils)
• Mongoose models (interfaces to MongoDB)
• Configuration modules (DB, passport strategies)
• Database: MongoDB
• External Services: Facebook OAuth 2.0, Google OAuth 2.0
• Deployment: Heroku (Procfile, env vars)
• Seed service (npm run seed) to bootstrap data
b. Relationships & interactions:
1. User → Browser → HTTP(S) request → Express router
2. Router invokes auth middleware (if protected) → passport strategy (local or OAuth)
3. Controller executes business logic → Mongoose model operations → MongoDB
4. Controller renders Handlebars view (injects JSON for charts) → Browser
6. External OAuth flow: Browser ↔ Facebook/Google OAuth endpoints ↔ Express callback route
c. Architectural patterns & principles:
• MVC (Model-View-Controller)
• Separation of concerns: routes vs controllers vs models vs views vs middleware
• Modularization: route modules, controller modules, utility modules
• Environment-based configuration (dotenv)
• Seed scripts for deterministic initial state
d. Key technologies/frameworks:
• Node.js, Express.js
• MongoDB + Mongoose ODM
• Passport.js (local, Facebook, Google strategies)
• Handlebars (hbs) for templating
• Chart.js for client-side data visualization
• Heroku for deployment