Skip to content

dworak-dev/auditor

Repository files navigation

auditor

This is a template repository for quickly setting up a Node.js worker project with TypeScript, ESLint, Jest, and more. It provides a foundation for developing and maintaining worker processes, enabling you to focus on the specifics of your task.

Features

  • TypeScript: Use TypeScript to take advantage of static types and modern JavaScript features.
  • ESLint: Use ESLint to catch and fix syntax and style errors early.
  • Jest: Test your code with Jest, a powerful JavaScript testing framework.
  • esbuild: Compile and bundle your code quickly with esbuild, a fast JavaScript bundler.
  • Husky: Manage git hooks with Husky, automating tasks such as linting and testing.
  • nodemon: Automatically restart your application when file changes in the directory are detected with nodemon.

Development

To install packages run

yarn

To start the project in development mode, use the following command:

yarn start:dev

Production

To build the project for production, use the following command:

yarn build

To start the project in production mode, use the following command:

yarn start

Other Scripts

Here are some other scripts that could come in handy:

  • lint: This runs ESLint on your project.
  • lint:fix: This runs ESLint and automatically fixes any issues that it can.
  • test: This runs Jest to test your project.

Contributing

If you have any suggestions or improvements, please feel free to create a pull request or submit an issue.

License

This project is licensed under the MIT license. Please see the LICENSE file for more information.