Skip to content

Quick repository setup for building Typescript based package.

License

Notifications You must be signed in to change notification settings

twig-it/typescript-starter-template

Repository files navigation

semantic-release

All Contributors

Typescript Starter Template Repository

This repository contains a ready to use, Typescript based startup project. Use this to quickly start working on a new project. This would save your time in terms of setting up the project, and you can just focus on building your library.

Salient Features:

  • Typescript
  • Rollup for bundling library.
  • Demo app that consumes this library for local development
  • Webpack for running demo app
  • Testing with Jest
  • Commit lint and Conventional Commits for commit format
  • Formatting with prettier
  • Husky for git hooks (commit and push)
  • Github Actions
  • Semantic Release with Github Actions
  • Auto Deploys demo app on Github Pages with every release

Instruction

  • Use this repo as a template for your project
  • Please replace each occurrence of your-library-name with your desired name.
  • Please replace each occurrence of your-app-name with your desired name.
  • Please replace each occurrence of org with your desired name.
  • Add your demo app contents
  • Test all scripts
  • Start building!!! :)

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Anand Tiwary

🤔 💻 🔧

This project follows the all-contributors specification. Contributions of any kind welcome!