{"id":22098109,"url":"https://github.com/qc2168/egg-starter","last_synced_at":"2025-08-14T08:13:37.815Z","repository":{"id":247062082,"uuid":"821220220","full_name":"QC2168/egg-starter","owner":"QC2168","description":"这是一个可以让您在短时间内构建Api的框架，它是基于EggJs官方的simple模板进行二次封装开发","archived":false,"fork":false,"pushed_at":"2024-08-06T12:48:26.000Z","size":40,"stargazers_count":15,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-01T02:43:47.341Z","etag":null,"topics":["egg","eggjs","mysql","nodejs","web"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/QC2168.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-06-28T04:33:16.000Z","updated_at":"2025-06-09T09:38:14.000Z","dependencies_parsed_at":"2024-07-06T11:28:56.328Z","dependency_job_id":"6198697f-a108-4926-ba13-ad6418217dfb","html_url":"https://github.com/QC2168/egg-starter","commit_stats":null,"previous_names":["qc2168/egg-starter"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/QC2168/egg-starter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QC2168%2Fegg-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QC2168%2Fegg-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QC2168%2Fegg-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QC2168%2Fegg-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/QC2168","download_url":"https://codeload.github.com/QC2168/egg-starter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QC2168%2Fegg-starter/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270385467,"owners_count":24574556,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-14T02:00:10.309Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["egg","eggjs","mysql","nodejs","web"],"created_at":"2024-12-01T04:18:12.948Z","updated_at":"2025-08-14T08:13:37.775Z","avatar_url":"https://github.com/QC2168.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Egg-Starter\n\n这是一个可以让您在短时间内构建`Api`的框架，它是基于`EggJs`官方的`simple`模板进行二次封装开发\n\n## 功能模块\n\n- [x] 🛠️ 统一错误处理机制\n- [x] 🔒 JWT验证模块\n- [x] 🧰 集成常用工具函数\n- [x] 🔄 更好的路由管理\n- [x] 🚀 基于EggJs快速构建Restful Api\n- [x] 🌐 纯Javascript\n- [x] 🐳 Sequelize Mysql\n- [x] 🍭 支持 DB Migration / Model Sync\n- [x] 📂 基于文件系统缓存服务\n- [x] 📚 集成Swaggar文档\n- [x] 🦄 集成Vscode代码片段\n- [x] 🔧 ESlint\n- [ ] 💪 **这些还不够？ 欢迎您来提**`Issues / PR`\n\n## 如何食用\n\n### 📥拉取代码\n\n克隆最新的代码仓库到您的电脑上\n\n```bash\ngit clone https://github.com/QC2168/egg-starter\n```\n\n### 📦安装依赖\n\n进入项目目录，执行`npm i`进行安装依赖\n\n```bash\nnpm i\n```\n\n\u003e 推荐使用`pnpm`包管理器进行安装依赖\n\n### ⚙️更新配置文件\n\n编辑项目中的`.env.development`文件，修改数据库配置信息\n\n```bash\nDB_DIALECT=mysql\nDB_HOST=127.0.0.1\nDB_PORT=3306\nDB_NAME=egg_starter\nDB_USER=root\nDB_PASSWORD=123456\n```\n\u003e 如果您的设备未安装配置数据库，推荐使用Docker镜像安装数据库，具体查阅docker文档\n\n### 🚀启动服务\n\n```bash\nnpm run dev\n```\n\n默认服务地址为`http://127.0.0.1:7001`\n\n\u003e 如果您想要修改其他端口地址，请编辑`.env.development`文件，修改`PORT`配置项\n\n## 🛠️部署\n\n🚀 [EggJs-应用部署](https://www.eggjs.org/zh-CN/core/deployment) - 确保您的应用可以稳定运行\n\n## 数据库迁移\n\n🗄️ 您可以选用[migrations](https://sequelize.org/docs/v6/other-topics/migrations/)来管理数据库迁移\n\n🔄 也可以直接使用[模型同步](https://sequelize.org/docs/v6/core-concepts/model-basics/#model-synchronization)的方式来生成数据库表（更快更便捷）\n\n💡 👇 开启模型同步的方式，请在`.env.development`文件中配置`DB_MODE=syncDB`即可\n\n```bash\n# .env.development\n# 是否使用模型同步更新数据库\nDB_MODE=syncDB\n```\n\n⚠️ 推荐使用数据库迁移的方式，因为模型同步的方式可能会导致数据丢失，且不支持回滚操作！！\n\n## 最后\n\n🎉 感谢您的使用，希望`Egg-Starter`能帮助您快速开发！\n\n最最最后，球球一个`Star` 🌹🌹\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqc2168%2Fegg-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqc2168%2Fegg-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqc2168%2Fegg-starter/lists"}