Yet Another NodeJS Template

An opinionated template for NodeJS projects that includes, out of the box:

• Next generation JS with Babel
• Unit testing with Jest
• Code coverage on Codecov
• Container-ready with Docker
• Efficient dependency management with pnpm
• Good-looking API documentation with JSDoc
• CI/CD pipeline on GitHub Actions with:
  • Node modules caching for faster pipelines
  • Linting, style and code duplication checking
  • Test execution and coverage report upload
  • Docker image build and push to DockerHub

For a slimmer version -- simpler and with less dependencies -- see yant-slim. The API documentation live preview is available at yant.upsetbit.co.

Compatibility

Any version above 12.x is okay: yant is tested against the latest three NodeJS LTS versions (12.x, 14.x and 16.x) and the most recent available (>= 17).

How can I use it?

Take what suits you, ignore or change what you do not like, and apply according to his will.

License

To the extent possible under law, Caian Ertl has waived all copyright and related or neighboring rights to this work. In the spirit of freedom of information, I encourage you to fork, modify, change, share, or do whatever you like with this project! ^C ^V