Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stacksjs/ts-starter
Quickly bootstrap your next TypeScript / Bun project.
https://github.com/stacksjs/ts-starter
Last synced: 20 days ago
JSON representation
Quickly bootstrap your next TypeScript / Bun project.
- Host: GitHub
- URL: https://github.com/stacksjs/ts-starter
- Owner: stacksjs
- License: mit
- Created: 2023-07-31T05:29:10.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-22T12:19:30.000Z (6 months ago)
- Last Synced: 2024-05-23T04:32:30.875Z (5 months ago)
- Language: JavaScript
- Homepage:
- Size: 2.1 MB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
- awesome-stacks - ts-starter - TypeScript Starter template to simplify creating & distributing your next npm package. (Projects Using Stacks / Scaffold)
README
[![npm version][npm-version-src]][npm-version-href]
[![GitHub Actions][github-actions-src]][github-actions-href]
[](http://commitizen.github.io/cz-cli/)
# bun-ts-starter
This is an opinionated TypeScript Starter kit to help kick-start development of your next Bun package.
## Get Started
It's rather simple to get your package development started:
```bash
# you may use this GitHub template or the following command:
bunx degit stacksjs/ts-starter my-pkg
cd my-pkg
# if you don't have pnpm installed, run `npm i -g pnpm`
bun i # install all deps
bun run build # builds the library for production-ready use
# how to create a git commit?
git add . # select the changes you want to commit
bun run commit # then simply answer the questions
# after you have successfully committed, you may create a "release"
bun run release # automates git commits, versioning, and changelog generations
```
_Check out the package.json scripts for more commands._
### Developer Experience (DX)
This Starter Kit comes pre-configured with the following:
- [Powerful Build Process](https://github.com/oven-sh/bun) - via Bun
- [Fully Typed APIs](https://www.typescriptlang.org/) - via TypeScript
- [Be a Good Commitizen](https://www.npmjs.com/package/git-cz) - pre-configured Commitizen & git-cz setup to simplify semantic git commits, versioning, and changelog generations
- [Built With Testing In Mind](https://bun.sh/docs/cli/test) - pre-configured unit-testing powered by [Bun](https://bun.sh/docs/cli/test)
- [Renovate](https://renovatebot.com/) - optimized & automated PR dependency updates
- [Biome](https://biomejs.dev/) - an instant, fast linter & formatter for JavaScript, TypeScript, and CSS
- [GitHub Actions](https://github.com/features/actions) - runs your CI _(fixes code style issues, tags releases & creates its changelogs, runs the test suite, etc.)_
## Testing
```bash
bun test
```
## Changelog
Please see our [releases](https://github.com/stackjs/bun-ts-starter/releases) page for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Community
For help, discussion about best practices, or any other conversation that would benefit from being searchable:
[Discussions on GitHub](https://github.com/stacksjs/ts-starter/discussions)
For casual chit-chat with others using this package:
[Join the Stacks Discord Server](https://discord.gg/stacksjs)
## Postcardware
Stacks OSS will always stay open-sourced, and we will always love to receive postcards from wherever Stacks is used! _And we also publish them on our website. Thank you, Spatie._
Our address: Stacks.js, 12665 Village Ln #2306, Playa Vista, CA 90094, United States 🌎
## Sponsors
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.
- [JetBrains](https://www.jetbrains.com/)
- [The Solana Foundation](https://solana.com/)
## 📄 License
The MIT License (MIT). Please see [LICENSE](LICENSE.md) for more information.
Made with 💙
[npm-version-src]: https://img.shields.io/npm/v/bun-ts-starter?style=flat-square
[npm-version-href]: https://npmjs.com/package/bun-ts-starter
[npm-downloads-src]: https://img.shields.io/npm/dm/bun-ts-starter?style=flat-square
[npm-downloads-href]: https://npmjs.com/package/bun-ts-starter
[github-actions-src]: https://img.shields.io/github/actions/workflow/status/stacksjs/ts-starter/ci.yml?style=flat-square&branch=main
[github-actions-href]: https://github.com/stacksjs/ts-starter/actions?query=workflow%3Aci