README.md

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:

• Powerful Build Engine - via unbuild
• Fully Typed APIs - via TypeScript 4.7
• Be a Good Commitizen - pre-configured Commitizen & git-cz setup to simplify semantic git commits, versioning, and changelog generations
• Built With Testing In Mind - pre-configured unit-testing powered by Vitest & e2e-testing by Cypress
• Renovate - optimized & automated PR dependency updates
• GitHub Actions - runs your CI (fixes code style issues, tags releases & creates its changelogs, runs the test suite, etc.

🧪 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 ❤️