How carole007/carole-admin works
Project type and purpose
• This is a full-stack, front-end/back-end-separated admin platform called Carole-Admin.
• Front-end: Vue3 + Vite + Element-Plus, based on RuoYi-Vue3.
• Back-end: NestJS (modular, Controller-Service architecture) + Prisma ORM + MySQL + ioredis + JWT + Swagger.
• Features: user/role/permission management, dynamic menus, code generation, caching/monitoring, rate limiting, scheduled tasks, file upload, email, API documentation.
File structure
• Top-level:
• front/ – Vue3 app (src, public, html templates, bin scripts, Vite config)
• server/ – NestJS app (src modules: admin, common, prisma, schedule, test, plus configs and scripts)
• carole.sql – initial DB dump
• Backend modules (server/src):
• admin/system & admin/gen – domain modules (controllers, services, DTOs)
• common – cross-cutting concerns (decorators, guards, filters, interceptors, middleware, pipes, Prisma client, utils, swagger vo, result wrappers)
• prisma/schema – database models, .env for DB URL
• schedule – Cron jobs
• Frontend structure (front/src):
• api – HTTP client wrappers per domain (login, menu, system, monitor, tool)
• components/layout/views – UI building blocks, layouts, pages
• router – Vue Router setup
• store – Vuex modules (app, user, permission, settings, tagsView, dict)
• plugins – custom Vue plugins (auth, cache, download, modal, tab)
• utils – shared helpers (request, auth, permissions, theme, validation)
README for additional insights
• Contains technology stack, setup instructions, built-in features list, config overview (config.ts), Prisma generation scripts, deployment notes, and code generation workflow.
• Confirms use of JWT for auth, Redis for caching & rate-limiting, scheduled Cron tasks, class-validator for DTO validation, Swagger UI for API docs.