How huasenjio/huasenjio-compose works
Project Type and Purpose
• This is a full‑stack, containerized web platform (“花森起始页”) composed of:
• A public “portal” front end (Vue.js SPA)
• An “admin” management front end (Vue.js SPA)
• A Node.js/Express back‑end service
• MongoDB for persistence
• Redis for caching/session/concurrency
• Nginx as a reverse proxy
• Jenkins for CI/CD
• Shell scripts for one‑click deploy & maintenance
File Structure Analysis
Top‐level directories reveal the system components:
• bin/ – deployment & upgrade scripts
• docker‑compose.yml – orchestrates containers
• huasen‑frontend/ – two Vue.js apps: admin & portal
• huasen‑server/ – Express app (MVC: router, controller, service, middleware, MongoDB models, plugins)
• huasen‑mongo/ – MongoDB init scripts & data volume
• huasen‑redis/ – Redis config & data
• huasen‑nginx/ – Nginx conf & static default pages
• huasen‑store/ – static assets (images, PDF, mini‑webapps)
• huasen‑lib/ – shared JS utility library
• Jenkins container defined in docker‑compose
Architectural Insights from README
• Layers:
• Edge: Nginx
• Presentation: portal & admin SPAs
• API: Node.js (Express)
• Data: MongoDB + Redis
• CI/CD: Jenkins
• Patterns: classic MVC on server; decoupled cache (Redis) and persistence (MongoDB); containerized micro‑services style; WebSocket channel for real‑time; scheduler for cron tasks; plugin-based middleware.
Diagramming the Architecture
a. Main Components (group as containers):
• Nginx Reverse Proxy Container
• Vue.js SPAs: portal app, admin app
• Express API Server Container
• MongoDB Container (with volume)
• Redis Container (with volume)
• Jenkins Container (CI/CD)
• Shell-script host (bin/*.sh) – for orchestration (outside containers)
b. Relationships & Data Flows:
1. Client browsers → HTTP(S) → Nginx
2. Nginx → static SPA assets or → API (proxy_pass to Express)
3. Portal/Admin SPAs ↔ RESTful HTTP (Axios) → Express API
4. Express API ↔ MongoDB (CRUD via Mongoose)
5. Express API ↔ Redis (ioredis plugin for caching, sessions, concurrency)
6. Express API ↔ WebSocket plugin for push updates
7. Express API ↔ Mail service (nodemailer plugin)
8. Express API ↔ Scheduler module (cron tasks)
9. Jenkins ↔ Git repo; Jenkins builds/ pushes new Docker images → docker‑compose
10. bin/*.sh scripts invoke Docker‑compose to start/stop/upgrade containers
c. Architectural Patterns & Principles:
• MVC Separation: router → controller → service → model
• Container per concern: each service in its own Docker container
• Decouple caching (Redis) & persistence (MongoDB)
• Plugin‑based extensibility in server (mail, jwt, throttle, ws)
• Scheduler for background jobs
• CI/CD pipeline with Jenkins
d. Key Technologies & Frameworks:
• Frontend: Vue.js (2.6.x), ElementUI, TailwindCSS, Axios
• Backend: Node.js (Express), Mongoose, ioredis, ws (WebSocket), nodemailer
• Data stores: MongoDB, Redis
• Orchestration: Docker & Docker‑compose
• Proxy: Nginx
• CI/CD: Jenkins