https://github.com/patelvivekdev/ts-package-template
A modern, efficient template for creating NPM packages using TypeScript.
https://github.com/patelvivekdev/ts-package-template
bun npm-package template typescript vitest
Last synced: 2 months ago
JSON representation
A modern, efficient template for creating NPM packages using TypeScript.
- Host: GitHub
- URL: https://github.com/patelvivekdev/ts-package-template
- Owner: patelvivekdev
- License: mit
- Created: 2024-12-01T23:51:24.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-05T21:49:24.000Z (over 1 year ago)
- Last Synced: 2025-01-30T06:25:56.829Z (over 1 year ago)
- Topics: bun, npm-package, template, typescript, vitest
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@patelvivekdev/ts-npm-template
- Size: 58.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# TypeScript NPM Package Template
A modern, efficient template for creating NPM packages using TypeScript.
## Why This Template?
- 🚀 Zero configuration setup
- 📦 Modern module bundling with tsup
- 🔍 Type-safe by default
- ⚡ Ultra-fast development with Bun
- 🧪 Comprehensive testing setup with Vitest
- 🔄 Continuous Integration ready
## Getting Started
1. Clone this template
2. Install dependencies:
```sh
bun install
```
3. Start development:
```sh
bun run dev
```
4. Build your package:
```sh
bun run build
```
5. Publish your package:
```sh
bun run local-release
```
## Project Structure
```
├── src/ # Source code with tests
├── dist/ # Built package (generated)
├── .github/ # GitHub workflows
└── .changeset/ # Changeset configs
```
## Important Resources
- [TSConfig Reference](https://www.typescriptlang.org/tsconfig)
- [Bun Documentation](https://bun.sh/docs)
- [Vitest Documentation](https://vitest.dev/)
- [tsup Documentation](https://tsup.egoist.dev/)
- [TypeScript Config Cheat Sheet](https://www.totaltypescript.com/tsconfig-cheat-sheet)
## License
MIT © Vivek Patel