Skip to content

zeeklog/Nuct.js

Repository files navigation

Nuct Logo

你只需要关注业务,将基础设施交给Nuct!

AI时代的企业平台开发底座基础设施。基于 NestJs +Vue3的企业级前后端分离快速开发脚手架, 将你的基础工作交给Cursor Rules & Skills。

Commit activity License Repo size Top language


  • 中小型应用的快速开发神器
  • 已配置 Cursor Rules,可接入 AI 辅助快速开发和交付

系统截图 📸

目录 📚

项目概览 ✨

  • 默认账号:admin,密码:a123456 🔑
  • 支持多租户隔离、RBAC 权限控制,适合中后台管理系统、SaaS 平台等场景

目录结构 🧱

nuct/
├── backend/          # 后端服务 (NestJS + TypeORM + Redis + MySQL)
├── frontend/         # 前端应用 (Vue3 + Vite + Ant Design Vue)
└── README.md

技术栈 🛠

层级 技术
后端 NestJS、TypeScript、TypeORM、Redis、MySQL
前端 Vue3、Vite5、Ant Design Vue4、TypeScript5

快速链接 🔗

演示地址 🌐

环境要求 📦

  • nodejs 20+
  • docker 20.x+(docker compose 需 2.17.0+)
  • mysql 8.x+
  • pnpm 包管理器

快速开始 🚀

Docker 快速体验

cd backend
pnpm docker:up
#
docker compose --env-file .env --env-file .env.production up -d --no-build

启动成功后访问:

停止并删除容器:

cd backend
pnpm docker:down

本地开发

1. 获取项目代码

git clone https://github.com/zeeklog/nuct
cd nuct

2. 准备工作

  • 数据库初始化:执行 backend/deploy/sql/nest_admin.sql
  • 配置文件:参考 backend/.envbackend/.env.developmentbackend/.env.production 配置 MySQL 和 Redis

可选:使用 Docker 启动 MySQL/Redis 供本地开发:

cd backend
docker compose --env-file .env --env-file .env.development run -d --service-ports mysql
docker compose --env-file .env --env-file .env.development run -d --service-ports redis

3. 启动后端

cd backend
pnpm install
pnpm migration:run   # 数据库迁移
pnpm dev

4. 启动前端

cd frontend
pnpm install
pnpm dev

5. 访问

子项目说明 📁

目录 说明 详细文档
backend/ NestJS 后端服务 backend/README.md
frontend/ Vue3 后台管理前端 frontend/README.md

数据库迁移 🗄

backend 目录下执行:

pnpm migration:run      # 更新/初始化数据库
pnpm migration:generate # 生成迁移
pnpm migration:revert   # 回滚

若实体类或数据库配置有更新,请先执行 pnpm build 再进行迁移。

Cursor AI 开发规则

项目已配置 Cursor Rules 与 Skills,便于 AI 辅助开发。规则与技能文件位于 .cursor/ 目录。

规则文件 (Rules)

文件 说明 作用范围
rules/00-project.mdc 项目架构与整体规范 始终应用
rules/01-frontend-style.mdc 前端 CSS 与命名规范 前端
rules/01-data-design.mdc 数据库设计与 RBAC 权限模型 后端
rules/02-backend.mdc NestJS 后端开发规范 backend/**/*.ts
rules/03-frontend.mdc Vue3 前端开发规范 frontend/**/*.{ts,vue}
rules/04-backend-docs.mdc 后端文档与 API 参考 后端
rules/tenant-init.mdc 租户初始化逻辑 tenant/**/*.ts

技能 (Skills)

技能 路径 用途
nest-admin-backend skills/nest-admin-backend/SKILL.md 后端开发、新增接口、控制器、Service、权限、数据库迁移
nest-admin-crud skills/nest-admin-crud/SKILL.md 新增 CRUD 模块全流程(实体、DTO、Service、Controller、菜单、前端页面)
nest-admin-permission skills/nest-admin-permission/SKILL.md RBAC 权限、菜单、按钮权限、definePermissionsys_menu 配置

使用示例

  • 开发后端接口:引用 nest-admin-backend skill 或 02-backend.mdc 规则
  • 新增 CRUD 模块:引用 nest-admin-crud skill
  • 配置权限与菜单:引用 nest-admin-permission skill

贡献 🤝

欢迎 Star 和 PR。

致谢 🙏

基于 buqiyuan 开源的 Nest_admin 二次开发租户隔离:

LICENSE

MIT

About

基于Nest的全栈企业级开发框架,支持租户隔离、RBAC、角色菜单权限配置等,适用于快速开发中小型应用;

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors