{"repo":"smarlhens/nest-boilerplate","free":true,"listed":false,"github":"https://github.com/smarlhens/nest-boilerplate","clone":"git clone https://github.com/smarlhens/nest-boilerplate.git","description":"Nest.js boilerplate with CircleCI, Commitizen, Commitlint, Docker-Compose, ESLint, GitHub Actions, Husky, Lint-staged, OpenAPI, Prettier, PostGreSQL, TypeORM","language":"TypeScript","stars":107,"topics":["nestjs","postgresql","circleci","github-actions","lint-staged","prettier","docker-compose","eslint","husky","commitlint"],"license":null,"category":"deployment-docker-iac","readme_excerpt":"Nest - Boilerplate Table of contents - Getting Started - Prerequisites - Installation - What's in the box ? - CircleCI - Commitlint - Docker Compose - ESLint - GitHub Actions - Husky - Lint-staged - Prettier - Running the app - Code scaffolding - Build - Test - Further help - Useful Docker commands --- Getting started These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. Prerequisites What things you need to install the software and how to install them : - Git - Node.js - Docker --- Installation 1. Clone the git repository 1. Go into the project directory 1. Checkout working branch 1. Install NPM dependencies 1. Copy .env.dist to .env 1. Replace the values of the variables with your own 1. Create Docker images and launch them --- What's in the box ? CircleCI CircleCI automates your software builds, tests, and deployments. CircleCI pipeline file : .circleci/config.yml . For more configuration options and details, see the configuration docs. --- Commitlint commitlint checks if your commit messages meet the conventional commit format. Configuration file : .commitlintrc.json . In general the pattern mostly looks like this: Are you a good commitizen ? --- Docker Compose Compose file : docker-compose.yml . Containers : - PostgreSQL 16 - pgAdmin 8 Compose file uses .env . --- ESLint ESLint is a fully pluggable tool for identifying and reporting on patterns in JavaScript. Configuration file : .eslintrc.js . Fo","default_branch":null,"files":null,"tree":[],"storefront":"/r/smarlhens","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/smarlhens/nest-boilerplate/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}