How thebyteflow/inker works
Project type and purpose
• This is a full-stack blog application (“INKER Blog”) implemented as a monorepo.
• Frontend: React + TypeScript + Vite, provides UI for users to read, create, edit posts, comment, follow, vote, manage profiles.
• Backend: Node.js + TypeScript (Express-style MVC with services & repositories), exposes RESTful JSON API, handles authentication (JWT + OTP), file uploads (Cloudinary), email, and interacts with MongoDB & Redis.
• Shared folder: contains common TypeScript types used by both frontend and backend for end-to-end type safety.
File structure
• Top-level directories
• /backend: API server
• /frontend: Single-page application
• /shared: Shared TypeScript definitions
• Backend layers conform to MVC + service + repository pattern:
• configs → external service and environment configurations (MongoDB, Redis, Mail, Cloudinary)
• routers → API endpoints
• controllers → request handling, input validation
• services → business logic
• repositories → data access abstractions over MongoDB
• models → Mongoose schema definitions
• middlewares → cross-cutting concerns (auth, rate limit, error handling)
• utils → low-level helpers (JWT, email, OTP, NanoID, error formatting)
• Frontend layers:
• src/router → route definitions (Protected/UnProtected)
• src/pages → top-level views
• src/components → reusable UI pieces (UI primitives, user/admin widgets)
• src/services → API call wrappers matching backend routes
• src/store (+ slices) → global state (Redux Toolkit or Zustand)
• shared types + env config + axios wrapper
• Deployment/config: Dockerfiles (backend), docker-compose.yaml for multi-container setup, Vercel config for frontend.
Extract architecture insights from README
• Uses Docker Compose to orchestrate services (backend, MongoDB, Redis).
• Follows SOLID & MVC principles.
• Environment variables drive service endpoints & credentials.
• Conventional commits and coding standards indicate clear modularity.
Final recommendation
• Drill down within the API block to show its layered modules.
• Link frontend pages/services to specific backend routers/endpoints.
• Keep it readable: avoid overcrowding; split into two views (overview + backend detail) if necessary.
• Review with team to confirm you captured all integration points (e.g., OTP service, rate-limiter, file upload pipeline).