Skip to content
/ ts-starter Public template

πŸ›« TypeScript Starter template to simplify creating & distributing your next npm package.

License

Notifications You must be signed in to change notification settings

ow3org/ts-starter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

46 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Social Card of TypeScript Starter

npm version GitHub Actions Commitizen friendly

The Simple Way

This is an opinionated TypeScript Starter kit to help kick-start development of your next npm package.

πŸ’‘ Get Started

Luckily, it's incredibly easy to get your package development started:

# you may use this GitHub template or the following command:
npx degit openwebstacks/ts-starter my-pkg
cd my-pkg

 # if you don't have pnpm installed, run `npm i -g pnpm`
pnpm i # install all deps
pnpm build # builds the library for production-ready use

# how to create a git commit?
git add . # select the changes you want to commit
pnpm run commit # then simply answer the questions

# after you have successfully committed, you may create a "release"
pnpm run release # automates git commits, versioning, and changelog generations

Developer Experience (DX)

This Starter Kit comes pre-configured with the following:

πŸ§ͺ Testing

pnpm test

πŸ“ˆ Changelog

Please see our releases page for more information on what has changed recently.

πŸ’ͺ🏼 Contributing

Please see CONTRIBUTING for details.

🏝 Community

For help, discussion about best practices, or any other conversation that would benefit from being searchable:

Discussions on GitHub

For casual chit-chat with others using this package:

Join the Open Web Discord Server

πŸ“„ License

The MIT License (MIT). Please see LICENSE for more information.

Made with ❀️