Project logo

NodeJS Boilerplate with TS and Jest

Status Issues Forks Stars License Top Language Last Commit Tweet


📝 Content table

🏁 Getting started with the project

Here is the instructions so you can initialize your own repository with this template and use it however you want.

First of all 0️⃣

Create your repository by clicking the “Use this template” button, it’s the green one at the top and right.

Prerequisite 📚

Make sure you have the node version this project uses or nvm to manage node versions, as well as one of the packages managers (yarn or npm) installed on your machine.

node -v
yarn -v
npm -v
nvm --help #this is optional

Installing :atom:

Download the project on your machine and run the command with yarn or npm to install the dependencies.

Note: If you are using nvm, before running, use nvm use to ensure your node version.

yarn
npm i

Wait until all dependencies have been installed and the folder node_modules show up.

Running ▶️

To run the application, use the start:dev script on package.json.

yarn start:dev
npm start:dev

⛏️ Tools

  • Typescript – a strongly typed programming language that builds on JavaScript, giving you better tooling at any scale.
  • Jest – a delightful JavaScript Testing Framework with a focus on simplicity
  • Lint Standard with Typescript – an ESLint shareable config for TypeScript.
  • Lint Staged – run linters against staged git files and don’t let 💩 slip into your code base!
  • Husky – modern native git hooks to improve your commits and more! 🐶 woof!
  • Module Alias – create aliases of directories and register custom module paths in NodeJS – like a boss!

Made by 👩🏾‍💻 Jessica Castro with 💙

GitHub

View Github