{"id":15137466,"url":"https://github.com/zrwusa/bunny-nest","last_synced_at":"2026-01-20T03:08:32.799Z","repository":{"id":257112698,"uuid":"857349743","full_name":"zrwusa/bunny-nest","owner":"zrwusa","description":"A best practice microservice based on NestJS, used to build RESTful APIs","archived":false,"fork":false,"pushed_at":"2024-09-16T23:58:09.000Z","size":155,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-09-27T07:01:14.600Z","etag":null,"topics":["dto","jwt","microservice","nestjs","oauth2","postgresql","protocol","restful-api","solid-principles","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/zrwusa.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}},"created_at":"2024-09-14T12:24:09.000Z","updated_at":"2024-09-16T23:58:12.000Z","dependencies_parsed_at":"2024-09-21T11:02:44.332Z","dependency_job_id":"774c9139-e13e-4d35-ab38-db87cfc9f869","html_url":"https://github.com/zrwusa/bunny-nest","commit_stats":null,"previous_names":["zrwusa/bunny-nest"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zrwusa%2Fbunny-nest","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zrwusa%2Fbunny-nest/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zrwusa%2Fbunny-nest/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zrwusa%2Fbunny-nest/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zrwusa","download_url":"https://codeload.github.com/zrwusa/bunny-nest/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219868241,"owners_count":16555798,"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":["dto","jwt","microservice","nestjs","oauth2","postgresql","protocol","restful-api","solid-principles","typeorm","typescript"],"created_at":"2024-09-26T07:00:48.928Z","updated_at":"2024-10-09T20:03:08.299Z","avatar_url":"https://github.com/zrwusa.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n## Description\n\n![system architecture diagram](https://raw.githubusercontent.com/zrwusa/assets/master/images/bunny-nest/bunny-farm.webp)\n\nBunny Nest is part of this system architecture and is responsible for the API service in this architecture.\n\nIt is a microservice framework based on NestJS, used to build RESTful APIs:\n\n - Implements Google and Github OAuth 2.0 authentication, and unifies JWT authentication. Session information is stored in Redis.\n - TypeORM combined with PostgreSQL is used to implement structured data storage.\n - Standardizes service layer communication protocols and standardizes controller layer communication protocols.\n - Implements i18n (internationalization).\n - Swagger UI\n - SOLID Principle\n\n\n\n## Project setup\n\n### .env setup\n```text\nPORT=8080\nFRONT_END_PORT=3000\n\nPOSTGRES_HOST=localhost\nPOSTGRES_PORT=5432\nPOSTGRES_USERNAME=postgres\nPOSTGRES_PASSWORD=your_postgres_password_here\nPOSTGRES_DATABASE=your_postgres_database_here\n\nGOOGLE_OAUTH2_AUTHORIZATION_URL=https://accounts.google.com/o/oauth2/auth\nGOOGLE_OAUTH2_TOKEN_URL=https://oauth2.googleapis.com/token\nSWAGGER_OAUTH2_REDIRECT_URL=http://localhost:8080/api/oauth2-redirect.html\n\nJWT_SECRET=your_secret_key_here\nJWT_ACCESS_TOKEN_EXPIRES_IN=15m\nJWT_REFRESH_TOKEN_EXPIRES_IN=7d\nJWT_SIGN_EXPIRES_IN=60m\nREDIS_HOST=localhost\nREDIS_PORT=6379\nREDIS_PASSWORD=\nGOOGLE_CLIENT_ID=your_google_client_id_here\nGOOGLE_CLIENT_SECRET=your_google_client_secret_here\nGOOGLE_AUTHORIZED_REDIRECT_URI=http://localhost:8080/auth/google/callback\nOAUTH2_LOGIN_CALLBACK_REDIRECT_URL=/success\nOAUTH2_GOOGLE_STRATEGY_CALLBACK_URL=http://localhost:8080/auth/google/callback\nOAUTH2_GITHUB_STRATEGY_CALLBACK_URL=http://localhost:8080/auth/github/callback\n\nGITHUB_CLIENT_ID=your_github_client_id_here\nGITHUB_CLIENT_SECRET=your_github_client_secret_here\n```\n\n```bash\n$ pnpm install\n```\n\n## Compile and run the project\n\n```bash\n# development\n$ pnpm run start\n\n# watch mode\n$ pnpm run start:dev\n\n# production mode\n$ pnpm run start:prod\n```\n\n## Run tests\n\n```bash\n# unit tests\n$ pnpm run test\n\n# e2e tests\n$ pnpm run test:e2e\n\n# test coverage\n$ pnpm run test:cov\n```\n\n## Resources\n\n## Stay in touch\n\n\n## License","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzrwusa%2Fbunny-nest","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzrwusa%2Fbunny-nest","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzrwusa%2Fbunny-nest/lists"}