这是一个可以让您在短时间内构建Api
的框架,它是基于EggJs
官方的simple
模板进行二次封装开发
- 🛠️ 统一错误处理机制
- 🔒 JWT验证模块
- 🧰 集成常用工具函数
- 🔄 更好的路由管理
- 🚀 基于EggJs快速构建Restful Api
- 🌐 纯Javascript
- 🐳 Sequelize Mysql
- 🍭 支持 DB Migration / Model Sync
- 📂 基于文件系统缓存服务
- 📚 集成Swaggar文档
- 🦄 集成Vscode代码片段
- 🔧 ESlint
- 💪 这些还不够? 欢迎您来提
Issues / PR
克隆最新的代码仓库到您的电脑上
git clone https://github.com/QC2168/egg-starter
进入项目目录,执行npm i
进行安装依赖
npm i
推荐使用
pnpm
包管理器进行安装依赖
编辑项目中的.env.development
文件,修改数据库配置信息
DB_DIALECT=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_NAME=egg_starter
DB_USER=root
DB_PASSWORD=123456
如果您的设备未安装配置数据库,推荐使用Docker镜像安装数据库,具体查阅docker文档
npm run dev
默认服务地址为http://127.0.0.1:7001
如果您想要修改其他端口地址,请编辑
.env.development
文件,修改PORT
配置项
🚀 EggJs-应用部署 - 确保您的应用可以稳定运行
🗄️ 您可以选用migrations来管理数据库迁移
🔄 也可以直接使用模型同步的方式来生成数据库表(更快更便捷)
💡 👇 开启模型同步的方式,请在.env.development
文件中配置DB_MODE=syncDB
即可
# .env.development
# 是否使用模型同步更新数据库
DB_MODE=syncDB
🎉 感谢您的使用,希望Egg-Starter
能帮助您快速开发!
最最最后,球球一个Star
🌹🌹