nestjs-boilerplate
NestJS boilerplate with TypeORM, ExpressJS, Fastify, Jest, I18n & Vuepress docs
File Explorer
Download Latest Version (.zip)- check-semantic-prs.yml
- ci.yml
- deploy-docs.yml
- release.yml
- pull-request-template.md
- commit-msg
- install.mjs
- pre-commit
- pre-push
- launch.json
- settings.json
- en.config.mjs
- vi.config.mjs
- config.mjs
- branch-conventions.md
- clean-code-typescript.md
- commit-conventions.md
- linting-and-formatting.md
- naming-cheatsheet.md
- styleguide.md
- branch-conventions.md
- clean-code-typescript.md
- README.md
- api.md
- architecture.md
- benchmarking.md
- database.md
- deployment.md
- development.md
- faq.md
- README.md
- security.md
- technologies.md
- testing.md
- troubleshooting.md
- auth-config.spec.ts
- auth-config.type.ts
- auth.config.ts
- login.req.dto.ts
- login.res.dto.ts
- refresh.req.dto.ts
- refresh.res.dto.ts
- register.req.dto.ts
- register.res.dto.ts
- jwt-payload.type.ts
- jwt-refresh-payload.type.ts
- auth.controller.spec.ts
- auth.controller.ts
- auth.module.ts
- auth.service.spec.ts
- auth.service.ts
- health.controller.spec.ts
- health.controller.ts
- health.module.ts
- home.controller.spec.ts
- home.controller.ts
- home.module.ts
- create-post.req.dto.ts
- list-post.req.dto.ts
- post.res.dto.ts
- update-post.req.dto.ts
- post.entity.ts
- post.controller.spec.ts
- post.controller.ts
- post.module.ts
- post.service.spec.ts
- post.service.ts
- create-user.req.dto.ts
- list-user.req.dto.ts
- load-more-users.req.dto.ts
- update-user.req.dto.ts
- user.res.dto.ts
- session.entity.ts
- user.entity.ts
- user.controller.spec.ts
- user.controller.ts
- user.module.ts
- user.repository.ts
- user.service.spec.ts
- user.service.ts
- api.module.ts
- email-queue.events.ts
- email-queue.module.ts
- email-queue.service.spec.ts
- email-queue.service.ts
- email.processor.ts
- background.module.ts
- cursor-pagination.dto.ts
- page-options.dto.ts
- paginated.dto.ts
- offset-pagination.dto.ts
- page-options.dto.ts
- paginated.dto.ts
- error-detail.dto.ts
- error.dto.ts
- job.interface.ts
- common.type.ts
- types.ts
- app-config.spec.ts
- app-config.type.ts
- app.config.ts
- config.type.ts
- app.constant.ts
- cache.constant.ts
- constraint-errors.ts
- entity.enum.ts
- error-code.constant.ts
- job.constant.ts
- sort.enum.ts
- database-config.spec.ts
- database-config.type.ts
- database.config.ts
- order.decorator.ts
- abstract.entity.ts
- post.factory.ts
- user.factory.ts
- 1721488504685-create-user-table.ts
- 1721550180313-create-session-table.ts
- 1722352657866-create-post-table.ts
- .gitkeep
- 1722335726360-user-seeder.ts
- 1722382752268-post-seeder.ts
- data-source.ts
- typeorm-config.service.ts
- is-both-or-none-present.decorator.ts
- is-ms.decorator.ts
- is-nullable.decorator.ts
- is-password.decorator.ts
- auth-optional.decorator.ts
- current-user.decorator.ts
- field.decorators.ts
- http.decorators.ts
- public.decorator.ts
- swagger.decorators.ts
- transform.decorators.ts
- validation.exception.ts
- global-exception.filter.ts
- i18n.generated.ts
- auth.guard.spec.ts
- auth.guard.ts
- common.json
- user.json
- common.json
- user.json
- common.json
- user.json
- aws.module.ts
- gcp.module.ts
- libs.module.ts
- mail-config.spec.ts
- mail-config.type.ts
- mail.config.ts
- email-verification.hbs
- mail.module.ts
- mail.service.ts
- redis-config.type.ts
- redis.config.ts
- shared.module.ts
- lower-case.transformer.ts
- cache.util.ts
- cursor-pagination.ts
- load-more.ts
- logger-factory.ts
- mailer-custom-logger.spec.ts
- mailer-custom-logger.ts
- modules-set.spec.ts
- modules-set.ts
- offset-pagination.ts
- password.util.spec.ts
- password.util.ts
- setup-swagger.spec.ts
- setup-swagger.ts
- typeorm-custom-logger.ts
- validate-config.spec.ts
- validate-config.ts
- app.module.ts
- main.ts
- app.e2e-spec.ts
- jest-e2e.json
- .dockerignore
- .editorconfig
- .env.docker
- .env.example
- .gitignore
- .npmrc
- .nvmrc
- .prettierrc
- .releaserc
- commitlint.config.mjs
- docker-compose.local.yml
- docker-compose.yml
- Dockerfile
- eslint.config.mjs
- jest.config.json
- LICENSE
- lint-staged.config.mjs
- maildev.Dockerfile
- nest-cli.json
- package.json
- pnpm-lock.yaml
- README.md
- renovate.json
- setup-jest.mjs
- tsconfig.build.json
- tsconfig.json
# Installation Guide
1. Get the code
git clone https://github.com/vndevteam/nestjs-boilerplate
Downloads the entire project code from GitHub to your computer.
cd nestjs-boilerplate
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose -f docker-compose.local.yml up -d --build
Runs the command against the services defined in the compose file.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. Node.js
EasyPrerequisites
pnpm install
Downloads and installs the libraries listed in package.json.
$ pnpm start
Starts the development/run server.
$ pnpm start:dev
Starts the development/run server.
$ pnpm start:prod
Starts the development/run server.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)