slash-admin: A modern react admin. It is based on react 18, vite and TypeScript. It's fast !
2024-05-13 21:31:15
预览
README
Slash Admin
Slash Admin 是一款现代化的后台管理模板,基于 React 18、Vite、Ant Design 和 TypeScript 构建。它旨在帮助开发人员快速搭建功能强大的后台管理系统。中文 | English
赞助
预览
特性
- 使用 React 18 hooks 进行构建。
- 基于 Vite 进行快速开发和热模块替换。
- 集成 Ant Design,提供丰富的 UI 组件和设计模式。
- 使用 TypeScript 编写,提供类型安全性和更好的开发体验。
- 响应式设计,适应各种屏幕尺寸和设备。
- 灵活的路由配置,支持多级嵌套路由。
- 集成权限管理,根据用户角色控制页面访问权限。
- 集成国际化支持,轻松切换多语言。
- 集成常见的后台管理功能,如用户管理、角色管理、权限管理等。
- 可定制的主题和样式,以满足您的品牌需求。
- 基于 MSW 和 Faker.js 的Mock方案
- 使用 Zustand 进行状态管理
- 使用 React-Query 进行数据获取
文档
快速开始
获取项目代码
git clone https://github.com/d3george/slash-admin.git
安装依赖
在项目根目录下运行以下命令安装项目依赖:
pnpm install
启动开发服务器
运行以下命令以启动开发服务器:
pnpm dev
访问 http://localhost:3001 查看您的应用程序。
构建生产版本
运行以下命令以构建生产版本:
pnpm build
构建后的文件将位于 dist
目录中。
容器化部署
构建镜像并运行容器
构建镜像
在终端中进入项目根目录,并执行以下命令来构建 Docker 镜像:
docker build -t your-image-name .
确保将 your-image-name
替换为你自己的镜像名称
运行容器
使用以下命令在 Docker 容器中运行你的应用:
docker run -p 3001:80 your-image-name
这将在容器的端口 80
(暴露在Dockerfile
中) 上运行你的应用,并将其映射到你主机的端口 3001
上。
现在,你可以通过访问 http://localhost:3001 来查看部署的应用。
使用docker-compose.yaml
在终端中进入项目根目录,并执行以下命令来启动 Docker Compose:
docker-compose up -d
Docker Compose 根据docker-compose.yaml
定义的配置构建镜像并在后台运行容器.
容器运行成功后,同样可以通过访问 http://localhost:3001来查看部署的应用。
feat
新功能fix
修复bugdocs
文档注释style
代码格式(不影响代码运行的变动)refactor
重构perf
性能优化revert
回滚committest
测试相关chore
构建过程或辅助工具的变动ci
修改CI配置、脚本types
类型定义文件修改wip
开发中
参与献者 ✨
感谢这些出色的贡献者 (emoji key):
kevin 🎨 🔧 💻 🐛 📖 |
YDiego 💻 🐛 |
付小晨 💻 🐛 |
xinmans 💻 🔧 |
stitch 💻 🐛 |
ntscshen 🔧 |
298977887 💻 |
eternallycyf 🔧 |
lei 🐛 |
fliu2476 🐛 |
tzcat8 📖 |