node-starter

What is this?

A good start to pretty much every Node.js project!

What's in it?

• ESLint and Prettier (using AirBnB's ruleset)
  • Ensures consistent formatting between developers!
• Commitlint
  • Ensures that git commit messages are consistent, and thought through.
  • Why is that important?
• Jest
  • Ensures that we can test our JavaScript.
• VSCode debugger
  • Ensures that we spend less time writing console.logs.
  • There's one debugger that runs the tests, and another for the whole project.
• Husky
  • Ensures that only work that is formatted correctly, and passes tests is committed.

How do I use this repo?

1. node-starter is a 'repository template', and is best used as a base for a new repository. Here's how you can do that.
2. Update 'name' property in the package.json file.

Run commands

• pnpm run start: Starts the project
• pnpm run test: Runs the tests - once
• pnpm run test:watch: Continually watches and runs the tests on code changes
• pnpm run lint: Formats the source code using ESLint