Any fool can write code that a computer can understand. Good programmers write code that humans can understand. – Martin Fowler

typescript-nestjs is a template project, designed by Templ Project.

typescript-nestjs includes instructions for initializing a new NestJs project, and configuring it for development, unit testing as well as code linting and analysis.

typescript-nestjs implements:

• jscpd, dependency-cruiser for code analisys
• prettier for code formatting
• eslint for linting

By default, this implementation uses yarn, but you can easily change it to npm or pnpm or any other package manager.

• Please install git-scm tool.
• Please install a form of make
  • Install Make for Windows
  • Install make from ezwinports
  • Install chocolatey, run choco install make

• Please install git and make

# i.e debian
sudo apt-get install git make -y
# i.e mac OS
brew install make git

• latest versions of @typescript-eslint/eslint-plugin will dismiss Node v11.x; change to older version of @typescript-eslint/eslint-plugin on your own risk.
• Windows tests do pass, however they encounter some issues at caching node_modules afterwards

git clone https://github.com/templ-project/typescript-nestjs your_project
cd your_project
rm -rf .git
git init
git add remote origin https://url/to/your/project/repository
git add .
git commit -am "init"
git push origin master
yarn install
# npm install
# pnpm install

• Please install NodeJs. We support version 10.x and above.
• Please instal a JavaScript/TypeScript IDE
  • Visual Studio Code with ITMCDev Babel Extension Pack or ITMCDev TypeScript Extension Pack
  • Jetbrains WebStorm
  • Vim with neoclide/coc.nvim and HerringtonDarkholme/yats.vim extensions.
  • Any other IDE you trust.

Run unit tests using yarn run test.

Testing is currently set to use unittest.

Run single unit tests file, by calling yarn run test:single -- test/path/to/file.test.js

yarn run test:single -- test/path/to/index.test.js

Run end to end tests using yarn run test:e2e.

Please check release-it for making releases to npmjs.com or any other repository tool, then run:

npm run release

• Dragos Cirjan - Initial work

Add a set of links to the issues page/website, so people can know where to add issues/bugs or ask for support.

(If the package is public, add licence) This project is licensed under the MIT License - see the LICENSE.md file for details

Remove Everything above this line

One Paragraph of project description goes here

• Templ NestJs (TypeScript)
  • Getting Started
    • Prerequisites / Dependencies
      • For Windows
      • For Linux/Unix/OSX
      • Known Issues / Troubleshooting
    • Installation
    • Development
      • Requirements
    • Testing
      • Single Tests
      • E2E Tests
    • Deployment
  • Authors
  • Issues / Support
  • License
• Project Title
  • Getting Started
    • Prerequisites / Dependencies
      • For Windows
      • For Linux
      • Known Issues / Troubleshooting
    • Installation
      • Say what the step will be
      • And repeat
    • Development
    • Testing
      • Break down into (at least) unit tests
      • and end to end tests
      • And coding style tests
    • Deployment
  • Authors
  • Issues / Support
  • License
  • Changelog

What things you need to install the software and how to install them (based on each OS type).

# Give Examples

npm install -g node-gyp windows-build-tools
# Warning: Please note windows-build-tools will install MSVS which takes a 
# LONG amount of time.

# Give Examples

apt-get install build-essential mono
npm install -y node-gyp

Describe a list of known issues, and how to bypass them.

A step by step series of examples that tell you how to get a development env running

Give the example

until finished

End with an example of getting some data out of the system or using it for a little demo

Explain any development process for the project, if necesary

give examples

Explain how to run the automated tests for this system

Explain what these tests test and why

Give an example

Explain what these tests test and why

Give an example

Explain what these tests test and why

Give an example

Add additional notes about how to deploy this on a live system

• Dragos Cirjan - Initial work - PurpleBooth

See also the list of contributors who participated in this project.

Add a set of links to the issues page/website, so people can know where to add issues/bugs or ask for support.

(If the package is public, add licence) This project is licensed under the MIT License - see the LICENSE.md file for details

Small changelog history. The rest should be added to CHANGELOG.md.

See here a template for changelogs: https://keepachangelog.com/en/1.0.0/

Also see this tool for automatically generating them: https://www.npmjs.com/package/changelog