Source of the template: https://github.com/franciscomesa/typescript-boilerplate
Source of the template realization process: https://leanmind.es/es/blog/como-configurar-un-boilerplate-con-typescript
Typescript and Node boilerplate template developer ready ๐ to get started quickly with all basic tools included and configured.
- Typescript 5
- Jest 29 testing
- Type definitions for Node.js and Jest
- Preconfigured scripts for common operations
- Documentation generator Typedoc
- Linting with ESLint 8
- .editorconfig settings for consistent file format
- CHANGELOG generator auto-changelog
- ๐ Available under the MIT license.
This project is designed to be used with the latest LTS version of Node.js.
Clone the repository:
git clone https://github.com/aitorevi/typescript-boilerplate-aitor.git your_local_project_name
cd your_local_project_name
After clone, just install project dependencies with npm i
command.
Test your installation with preconfigured test and script
npm start
๐ช Ready for code!
start
: run de default scriptbuild
: transpile TypeScript to es2020test
: run teststest:coverage
: run and show test coveragetest:watch
: interactive watch mode to automatically re-run testslint
: lint source files and testslint:fix
: automatically fix source files and test with linterdependencies:purge
: remove installed packages and install all of them againdocs:generate
: generate CHANGELOG and documentation in Markdown formatdocs:update
: generate CHANGELOG and documentation in Markdown format and commit changelogdocs:generate:html
: generate CHANGELOG and documentation in HTML format
- Remove unused settings in config files.
- Include GitHub Actions / GitLab CI