An opinionated template for TypeScript projects that includes, out of the box:
- Type-safe JS with TypeScript
- Fast transpilation with SWC
- Unit testing with Jest
- Code coverage on Codecov
- Container-ready with Docker
- Efficient dependency management with pnpm
- Good-looking API documentation with TypeDoc
- 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
The API documentation live preview is available at yatt.upsetbit.co.
Any version >= 14 should be okay: yatt is tested against the latest (minor/patch) versions of NodeJS 14, 15, 16, 17 and 18.
Take what suits you, ignore or change what you do not like, and apply according to his will.
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
