{"id":16454283,"url":"https://github.com/supervons/explorekoa","last_synced_at":"2025-03-23T10:32:26.537Z","repository":{"id":55058351,"uuid":"370015140","full_name":"supervons/ExploreKoa","owner":"supervons","description":"Koa2 + Typescript 构建的后端项目，全栈工程师必学！！！","archived":false,"fork":false,"pushed_at":"2023-09-20T09:25:20.000Z","size":341,"stargazers_count":28,"open_issues_count":0,"forks_count":7,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-12T10:18:34.177Z","etag":null,"topics":["koa","koa-demo","koa-redis","koa2","koa2-demo","nodejs-server","typeorm","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/supervons.png","metadata":{"files":{"readme":"README.en.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}},"created_at":"2021-05-23T09:52:15.000Z","updated_at":"2024-09-02T08:35:29.000Z","dependencies_parsed_at":"2023-02-17T21:46:10.638Z","dependency_job_id":null,"html_url":"https://github.com/supervons/ExploreKoa","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/supervons%2FExploreKoa","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/supervons%2FExploreKoa/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/supervons%2FExploreKoa/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/supervons%2FExploreKoa/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/supervons","download_url":"https://codeload.github.com/supervons/ExploreKoa/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221849337,"owners_count":16891426,"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","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":["koa","koa-demo","koa-redis","koa2","koa2-demo","nodejs-server","typeorm","typescript"],"created_at":"2024-10-11T10:18:35.010Z","updated_at":"2024-10-28T15:32:52.281Z","avatar_url":"https://github.com/supervons.png","language":"TypeScript","readme":"[简体中文](./README.md) | [English](./README.en.md)\n\n### KOA2 + TypeScript built back-end projects that full stack engineers must learn !!!\n\nThe front-end project address: https://github.com/supervons/ExploreRN\n\n### Finished\n\n- [x] Project Init\n- [x] Login and Register\n- [x] Api add authentication - JWT\n- [x] Update password and user information\n- [x] CURD function for profile information such as avatar, theme and motto\n- [x] WebSocket API Demo\n- [x] Send email\n- [x] cabin + axe + signale log middleware\n\n### TODO-LIST\n\n- [ ] Change `typeorm` to `prisma`\n- [ ] SQL optimize\n- [ ] Redis-based list query acceleration\n\n### Project Start - Develop\n\n```\nnpm install\nnpm run start\n```\n\n### Project pm2 - Deploy\n\n```\nnpm run build\nnpm run pro\n```\n\n### PROJECT DIR INTRODUCE\n\n```\n.\n├── src\n│   ├── controller        // controller\n│   ├── entity\n│   ├── redis             //redis config\n│   ├── router            //route config\n│   ├── service           //service\n│   ├── config.ts         //project common config\n│   ├── constants.ts      //project const value\n│   └── index.ts          //entrance index.js\n├── .env                  //config file\n├── ecosystem.config.js   //pm2 config\n├── ormconfig.json        //database ORM config file\n├── nodemon.json          //nodemon config\n├── package.json          //npm config\n└── tsconfig.json         //ts config\n```\n\n### Table Structure\n\n\u003cimg src=\"./public/explore.png\" alt=\"Structure\" align=\"center\"/\u003e\n\n## Before Start\n\n- MySQL\n- Redis\n\nRecommended `Docker`.\n\n### Config\n\n### Redis\n\n`.env`\n\n- `PORT_REDIS` Redis port\n- `HOST_REDIS` Redis host\n- `PASSWORD_REDIS` Redis password\n\n### MySQL\n\n`ormconfig.ts`\n\n- `type` DB type\n- `host` DB host\n\nRead more: https://github.com/typeorm/typeorm\n\n### Email\n\n`src/utils/email.ts`\n\n- `host` Your email provider host.\n- `port`Your email provider part.\n- `auth`\n  - `user` Email account, sender by it.\n  - `pass` Pass token, check your email provider setting.\n\n### Database file path\n\n```\n./public/mysql.sql\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsupervons%2Fexplorekoa","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsupervons%2Fexplorekoa","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsupervons%2Fexplorekoa/lists"}