oa_based/README.md

环境要求

• nodejs 16.20.2+
• docker 20.x+ ，其中 docker compose版本需要 2.17.0+
• mysql 8.x+
• 使用 pnpm 包管理器安装项目依赖

账号	密码	权限
admin	a123456	超级管理员

本地开发

• 【可选】如果你是新手，还不太会搭建mysql/redis，你可以使用 Docker 启动指定服务供本地开发时使用, 例如：

# 启动MySql服务
docker compose --env-file .env --env-file .env.development run -d --service-ports mysql
# 启动Redis服务
docker compose --env-file .env --env-file .env.development run -d --service-ports redis

• 安装依赖

pnpm install

• 运行 启动成功后，通过 http://localhost:7001/api-docs/ 访问。

pnpm dev

• 打包

pnpm build

2.使用docker运行

docker compose up -d

停止并删除所有容器

pnpm docker:down
# or
docker compose --env-file .env --env-file .env.production down

删除镜像

pnpm docker:rmi
# or
docker rmi huaxin-admin-server:stable

查看实时日志输出

pnpm docker:logs
# or
docker compose --env-file .env --env-file .env.production logs -f

数据库迁移

1. 更新数据库(或初始化数据)

pnpm migration:run

2. 生成迁移

pnpm migration:generate

3. 回滚到最后一次更新

pnpm migration:revert

4.执行sql覆盖docker中的数据库

docker exec -i huaxin-admin-mysql mysql -h 127.0.0.1 -u root -phuaxin123 hxoa < hxoa_2024-03-07_171919.sql

更多细节，请移步至官方文档

[!TIP] 如果你的实体类或数据库配置有更新，请执行npm run build后再进行数据库迁移相关操作。

部署

chmod +x deploy.sh ./deploy.sh