How mhistiak3/mindscribe works
Project type and purpose
• MindScribe is a full-stack, monolithic web application for blogging.
• Backend: Node.js + Express.js server handling routing, business logic, session management.
• Frontend: EJS templates rendered server-side, plus client-side JS, CSS, images served from a public folder.
• Database: MongoDB (via Mongoose) for users, blogs, sessions (connect-mongo).
• External services: Cloudinary for image storage, Markdown-it/highlight.js for Markdown parsing and syntax highlighting.
File structure
• Top-level:
• app.js – entry point
• public/ – static assets (css, images, client-side js modules)
• views/ – EJS templates (pages + partials)
• src/ – MVC backbone:
– config/ (DB, Cloudinary, Markdown, session)
– routes/ (Express routers per feature)
– controllers/ (per-feature business logic)
– models/ (UserModel, BlogModel)
– middlewares/ (userAuth)
– utilities/ (helpers: pagination, reading time, image utilities)
• Config files: .env for env vars, package.json for deps.
• Patterns: MVC, layered architecture (presentation → controllers → models).
Key README insights
• Auth (register, login/logout) using express-session + connect-mongo.
• CRUD on blogs (create, read, update, delete).
• Public vs authenticated routes.
• Cloudinary for image uploads.
• EJS for server-side rendering, client JS for dynamic pieces (dialogs, toasts, visit counts).
Main components & relationships
a. Presentation Layer
• Browser (UI): EJS-rendered HTML + client JS modules (login.js, createBlog.js, etc.) + CSS.
• Static asset server: Express serves /public.
b. Application Layer
• Express server (app.js)
– Middleware chain: dotenv, session, connect-mongo, userAuth, compression, routers.
– Routing: routes/* → controllers/*.
– Controllers invoke Mongoose models and utilities, then render views or JSON.
c. Data Layer
• MongoDB database: collections for users, blogs, sessions.
• Mongoose ODM for schema and queries.
• -mongo session store.
d. External Services
• Cloudinary API for image uploads.
• markdown-it & highlight.js for parsing blog content.
Interactions:
1. Browser → HTTP request → Express router.
2. Router → Controller → (optionally) Middleware checks auth.
3. Controller → Model (Mongoose) → MongoDB.
4. Controller → Cloudinary SDK (for image uploads).
5. Controller → render EJS view or send JSON.
6. Response → Browser.
Architectural patterns & design principles
• MVC: clear separation of concerns (views, controllers, models).
• Layered architecture: presentation, business logic, data access.
• RESTful routing for blog & auth endpoints.
• Middleware pipelines for cross-cutting concerns (auth, sessions, compression).
• Utility modules for reusable functions (pagination, reading time, image handling).