Professional Template with automated CI/CD, TypeDoc-generated documentation, and production-ready semantic versioning.

gitGraph
  commit
  branch develop
  checkout develop
  commit
  commit
  checkout main
  merge develop
  commit tag: "v1.0.0"

Core Infrastructure

• ☑️ Node.js + TypeScript
• ☑️ Vitest (Unit Testing)
• ☑️ Semantic Release
• ☑️ Actions CI/CD
• ☑️ Actions Pages

Quality Assurance

• ☑️ BiomeJS (Linting/Formatting)
• ☑️ Husky + Lint Staged
• ☑️ Commitlint + Conventional Commits
• ☑️ CodeQL Scanning

Project Scaffolding

• ☑️ Docs: Contribution Guide & Code of Conduct
• ☑️ Husky Git Hooks
• ☑️ Automated CHANGELOG.md
• ☑️ TypeDoc + Vitepress for Documentation Site

Perfect for developers who need:

1. Zero-config TypeScript library setup
2. Automated docs with TypeDoc
3. CI/CD pipeline with Actions
4. Semantic versioning right out of the box

• Building npm packages
• Open source projects
• Enterprise-grade libraries

npx degit heliomarpm/tsapp-template your-app
cd your-app
npm install

You'll need to update the workflow permissions in your repository.

• Access the repository's Settings section
• Access Actions in the side menu
• Check the Read and write permissions option and Allow Actions to create and approve pull requests

see TypeDoc Vitepress

• First time: npx vitepress init
• Documentation code base: npm run docs or npm run docs:dev

Test releasing without version bump:

npm run release:test
# or 
npx semantic-release --dry-run

✅ Zero runtime dependencies
🔄 All devDependencies are pinned to latest stable versions

We welcome contributions! Please read:

• Code of Conduct
• Contributing Guide

Thank you to everyone who has already contributed to the project!

If this project helped you in any way, there are several ways to contribute.
Help us maintain and improve this template:

⭐ Starring the repository
🐞 Reporting bugs
💡 Suggest features
🧾 Improving the documentation
📢 Share with others

💰 Supporting via Sponsors, Ko-fi, Paypal, LiberaPay

MIT © Heliomar P. Marques 🔝