This is an opinionated TypeScript Starter kit to help kick-start development of your next Bun package.
This Starter Kit comes pre-configured with the following:
- 🛠️ Powerful Build Process - via Bun
- 💪🏽 Fully Typed APIs - via TypeScript
- 📚 Documentation-ready - via VitePress
- ⌘ CLI & Binary - via Bun & CAC
- 🧪 Built With Testing In Mind - pre-configured unit-testing powered by Bun
- 🤖 Renovate - optimized & automated PR dependency updates
- 🎨 ESLint - for code linting (and formatting)
- 📦️ pkg.pr.new - Continuous (Preview) Releases for your libraries
- 🐙 GitHub Actions - runs your CI (fixes code style issues, tags releases & creates its changelogs, runs the test suite, etc.)
It's rather simple to get your package development started:
# you may use this GitHub template or the following command:
bunx degit stacksjs/ts-starter my-pkg
cd my-pkg
bun i # install all deps
bun run build # builds the library for production-ready use
# after you have successfully committed, you may create a "release"
bun run release # automates git commits, versioning, and changelog generationsCheck out the package.json scripts for more commands.
bun testPlease see our releases page for more information on what has changed recently.
Please see CONTRIBUTING for details.
For help, discussion about best practices, or any other conversation that would benefit from being searchable:
For casual chit-chat with others using this package:
Join the Stacks Discord Server
“Software that is free, but hopes for a postcard.” We love receiving postcards from around the world showing where Stacks is being used! We showcase them on our website too.
Our address: Stacks.js, 12665 Village Ln #2306, Playa Vista, CA 90094, United States 🌎
We would like to extend our thanks to the following sponsors for funding Stacks development. If you are interested in becoming a sponsor, please reach out to us.
The MIT License (MIT). Please see LICENSE for more information.
Made with 💙
![@renovate[bot]](https://avatars.githubusercontent.com/in/2740?s=64&v=4){kind=small}
