https://github.com/stacksjs/ts-prompts
🎨 Pretty command-line applications.
https://github.com/stacksjs/ts-prompts
application bun cli library nodejs prompts typescript
Last synced: about 1 year ago
JSON representation
🎨 Pretty command-line applications.
- Host: GitHub
- URL: https://github.com/stacksjs/ts-prompts
- Owner: stacksjs
- License: mit
- Created: 2025-04-12T22:14:33.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-13T00:10:09.000Z (about 1 year ago)
- Last Synced: 2025-04-13T00:18:22.984Z (about 1 year ago)
- Topics: application, bun, cli, library, nodejs, prompts, typescript
- Language: TypeScript
- Homepage: https://ts-prompts.netlify.app
- Size: 449 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
[![npm version][npm-version-src]][npm-version-href]
[![GitHub Actions][github-actions-src]][github-actions-href]
[](http://commitizen.github.io/cz-cli/)
# ts-prompts
This is an opinionated TypeScript Starter kit to help kick-start development of your next Bun package.
## Features
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
- 📚 [Documentation-ready](https://vitepress.dev/) - via VitePress
- ⌘ [CLI & Binary](https://www.npmjs.com/package/bunx) - via Bun & CAC
- 🧪 [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
- 🎨 [ESLint](https://eslint.org/) - for code linting _(and formatting)_
- 📦️ [pkg.pr.new](https://pkg.pr.new) - Continuous (Preview) Releases for your libraries
- 🐙 [GitHub Actions](https://github.com/features/actions) - runs your CI _(fixes code style issues, tags releases & creates its changelogs, runs the test suite, etc.)_
- 🚀 [Stacks.js Onboarding](https://stacks.js.org) - Interactive CLI for setting up Stacks.js projects
## 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-prompts 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 generations
```
_Check out the package.json scripts for more commands._
## Stacks.js Setup
To create a new Stacks.js project using the interactive onboarding process:
```bash
# Using npx
npx ts-prompts create-stacks
# Or after installing globally
npm install -g ts-prompts
stacks-init
```
The CLI will guide you through the setup process, allowing you to configure:
- Project name and description
- Database type (PostgreSQL, MySQL, SQLite, MongoDB)
- Features to include (Authentication, APIs, Admin Dashboard, etc.)
- TypeORM integration
- Git initialization
- Dependency installation
After completing the wizard, you'll have a fully configured Stacks.js project ready for development.
## Testing
```bash
bun test
```
## Changelog
Please see our [releases](https://github.com/stackjs/ts-prompts/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-prompts/discussions)
For casual chit-chat with others using this package:
[Join the Stacks Discord Server](https://discord.gg/stacksjs)
## Postcardware
"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 🌎
## 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/ts-prompts?style=flat-square
[npm-version-href]: https://npmjs.com/package/ts-prompts
[github-actions-src]: https://img.shields.io/github/actions/workflow/status/stacksjs/ts-prompts/ci.yml?style=flat-square&branch=main
[github-actions-href]: https://github.com/stacksjs/ts-prompts/actions?query=workflow%3Aci