https://github.com/maxam2017/bun-lib-starter

$ bun create maxam2017/bun-lib-starter <your-project-name>
https://github.com/maxam2017/bun-lib-starter

Last synced: 10 months ago
JSON representation

$ bun create maxam2017/bun-lib-starter <your-project-name>

• Host: GitHub
• URL: https://github.com/maxam2017/bun-lib-starter
• Owner: maxam2017
• License: mit
• Created: 2024-01-01T11:02:23.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-01-01T12:34:35.000Z (over 2 years ago)
• Last Synced: 2025-10-03T21:56:21.987Z (10 months ago)
• Language: TypeScript
• Homepage:
• Size: 130 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# bun-lib-starter

![Bun](https://img.shields.io/badge/bun-282a36?style=for-the-badge&logo=bun&logoColor=fbf0df)

![Typescript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)

![License](https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=for-the-badge)

A starter template for node library built with bun.

## What's included

- 🚀 **Typescript Support**

- 🧼 **Linting and Formatting with Pre-commit Hooks** (Powered by pre-commit and biomejs)

- 📦 **Efficient Bundling with tsup** (Supporting both cjs and esm)

- 🧪 **Inclusive Built-in Test Runner** (Powered by bun)

- 🌐 **GitHub Actions for CI/CD and Semantic Release Automation**

## Getting Started

### Prerequisites

- [bun](https://bun.sh/docs/installation)

- [pre-commit](https://pre-commit.com/#install)

### Installation

Use bun CLI to create a new project **(recommended)**

```sh

bun create maxam2017/bun-lib-starter 

```

or clone this repo and install manually

```sh

git clone https://github.com/maxam2017/bun-lib-starter.git

cd bun-lib-starter

pre-commit install

bun install

```

### Development

1. Run in dev mode (watch mode)

   ```sh

   bun dev

   ```

1. Run tests

   ```sh

    bun test

   ```

## License

Distributed under the MIT License. See `LICENSE` for more information.