{"id":20574326,"url":"https://github.com/hoojinguyen/nestjs-base","last_synced_at":"2026-04-09T23:49:19.160Z","repository":{"id":158045638,"uuid":"475235639","full_name":"hoojinguyen/nestjs-base","owner":"hoojinguyen","description":"This is a basic project with Nest framework, along with neat source code organization and many pre-configured features and techniques.","archived":false,"fork":false,"pushed_at":"2023-02-11T03:20:57.000Z","size":247,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-16T21:36:40.103Z","etag":null,"topics":["aws-s3","bull","docker","docker-compose","logger","mailer","nestjs","passport-jwt","queue","redis","redis-commander","scheduled-task","typeorm","typescript","winston-logger"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hoojinguyen.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2022-03-29T01:21:03.000Z","updated_at":"2023-10-19T03:51:37.000Z","dependencies_parsed_at":"2023-07-07T03:16:04.105Z","dependency_job_id":null,"html_url":"https://github.com/hoojinguyen/nestjs-base","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/hoojinguyen%2Fnestjs-base","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hoojinguyen%2Fnestjs-base/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hoojinguyen%2Fnestjs-base/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hoojinguyen%2Fnestjs-base/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hoojinguyen","download_url":"https://codeload.github.com/hoojinguyen/nestjs-base/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242195676,"owners_count":20087757,"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":["aws-s3","bull","docker","docker-compose","logger","mailer","nestjs","passport-jwt","queue","redis","redis-commander","scheduled-task","typeorm","typescript","winston-logger"],"created_at":"2024-11-16T05:33:33.556Z","updated_at":"2026-04-09T23:49:14.106Z","avatar_url":"https://github.com/hoojinguyen.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"http://nestjs.com/\" target=\"blank\"\u003e\u003cimg src=\"https://nestjs.com/img/logo_text.svg\" width=\"320\" alt=\"Nest Logo\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## Description\n\nThis is a basic project with [Nest](https://github.com/nestjs/nest) framework, along with neat source code organization and many pre-configured features and techniques.\n\n## Features and Techniques\n\n- Authentication (passport JWT)\n- Authorization (ACL)\n- Security\n- Emailing Queue (bull)\n- API Document (swagger)\n- File uploads. Support local and Amazon S3 drivers\n- Server static\n- Schedule with cronjobs\n- Check health\n- Caching (redis)\n- Cache manager (redis-commander)\n- Logging (winston)\n- CRUD\n- Pagination (nestjs-paginate)\n- Request Validation\n- Config Service\n- TypeORM\n- Migration and seeding\n- E2E and units tests\n- CI/CD\n\n## Getting Started\n\nTo start developing the project please check if you have these tools installed on your machine:\n\n- [Node.js](https://nodejs.org/en/download/)\n- [Yarn](https://yarnpkg.com/getting-started/install)\n- [Docker](https://www.docker.com/get-started)\n\n### Installation\n\n1. Clone the repo\n\n```sh\ngit clone https://github.com/hoojinguyen/nestjs-base\n```\n\n2. Move into project\n\n```sh\ncd nestjs-base\n```\n\n3. Install project dependencies\n\n```sh\nyarn\n```\n\n4. Copy .env.example file as .env and fill it with your environment variables\n\n```sh\ncp .env.example .env\n```\n\n5. Running with docker\n\n- Start development environment:\n\n```sh\ndocker-compose -f docker-compose.dev.yml up -d\n\n# or run script\n# sh run.sh up-dev\n```\n\n- Start development environment with debugger on vscode:\n\n```sh\ndocker-compose -f docker-compose.debug.yml up -d\n\n# or run script\n# sh run.sh up-debug\n```\n\n\u003e - **You can access to API by URL: http://localhost:3001/api in browser**\n\u003e - **You can access to redis commander by URL: http://localhost:8081 in browser**\n\n6. Stopping\n\n```sh\ndocker-compose -f docker-compose.dev.yml up -d # dev env\n\ndocker-compose -f docker-compose.debug.yml up -d # debug env\n\n# or run script\n# sh run.sh down-dev || sh run.sh down-debug\n```\n\n## Todo\n\n- [ ] Write API document with Swagger\n- [ ] Write units tests for every module\n- [ ] Switch the way authorization from ACL to RBAC\n- [ ] Switch Message queues from bull to RabbitMQ or Kafka\n- [ ] Create migration and seeding\n- [ ] Multiple databases\n- [ ] CI/CD\n- [ ] Deployment to product\n\n## License\n\nThis project is available under the [MIT licensed](LICENSE). See `LICENSE` for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhoojinguyen%2Fnestjs-base","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhoojinguyen%2Fnestjs-base","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhoojinguyen%2Fnestjs-base/lists"}