How joel-johny/memories works
Main Components
• Frontend:
• Built using React and Vite.
• Contains components like CalendarModal, MemoryCard, MoodPicker, and various pages (Dashboard, Login, Register, etc.).
• Utilizes Tailwind CSS for styling.
• Backend:
• Node.js and Express server managing the API.
• Organized in an MVC-like pattern: controllers (authController, journalController, userController), models (User, Journal, EmailVerificationMagicLink), routes, middleware (authentication, file upload handling via Multer and Cloudinary), and utility modules for tasks such as email dispatching and file cleanup.
• Database:
• MongoDB (as inferred from the README and environment variables) for storing user data and journal entries.
• External Services:
• Cloudinary for media management (uploading files, generating thumbnails, cleanup).
• Email service (using Nodemailer) for sending email verification links.
• Environment/Deployment:
• Configuration files (.env for both frontend and backend), vercel.json for deployment, and scripts to run servers concurrently.
Determining Relationships and Interactions
• Frontend ↔ Backend:
• The React-based UI interacts with the backend through RESTful APIs.
• API calls handle authentication (login, registration, email verification) and CRUD operations for journal entries.
• Backend ↔ Database:
• Node.js/Express communicates with MongoDB to perform database operations.
• Models define schemas for users, journals, etc.
• Backend ↔ External Services:
• Uses Cloudinary integration for handling multimedia uploads.
• Integrates with an email service (via Nodemailer) for sending verification emails.
• Data Flow:
• Users interact via the UI to trigger API requests.
• Authentication middleware verifies requests using JWT tokens.
• Controllers coordinate business logic, querying or updating data in the database, and handling file operations through middleware.
Architectural Patterns and Principles
• MVC-like pattern on the backend: clear separation between models, controllers, and routes.
• Modular design: separation of concerns is visible through folder segregation (e.g., separate directories for middleware, utils, configurations).
• API-driven communications: REST APIs to facilitate frontend-backend interactions.
• Cloud integration for specialized tasks (media management and email verification).
• Environment-specific configuration using .env files, facilitating different setups (development, production).
Relevant Technologies and Frameworks
• Frontend: React, Vite, Tailwind CSS.
• Backend: Node.js, Express.js.
• Database: MongoDB.
• Authentication: JWT.
• External: Cloudinary & Nodemailer.