ddialar/typescript-boilerplate

Typescript and Node boilerplate template developer ready 🚀 to get started quickly with all basic tools included and configured.

typescript-boilerplate

Typescript and Node boilerplate template developer ready 🚀 to get started quickly with all basic tools included and configured.

🧑‍🔬 Basic tools included and preconfigured to be used

• Typescript 4
• Jest 27 testing
• Type definitions for Node.js and Jest
• Preconfigured scripts for common operations
• Documentation generator Typedoc
• Linting with ESLint 7
• .editorconfig settings for consistent file format
• CHANGELOG generator auto-changelog
• 🔖 Available under the MIT license.

Fast start

This project is designed to be used with the latest LTS version of Node.js.

Clone the repository:

git clone https://github.com/franciscomesa/typescript-boilerplate.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!

Scripts configured

• start: run de default script
• build: transpile TypeScript to es2020
• test: run tests
• test:coverage: run and show test coverage
• test:watch: interactive watch mode to automatically re-run tests
• lint: lint source files and tests
• lint:fix: automatically fix source files and test with linter
• dependencies:purge: remove installed packages and install all of them again
• docs:generate: generate CHANGELOG and documentation in Markdown format
• docs:update: generate CHANGELOG and documentation in Markdown format and commit changelog
• docs:generate:html: generate CHANGELOG and documentation in HTML format

Next steps

• Remove unused settings in config files.
• Include GitHub Actions / GitLab CI