https://github.com/ndxbn/bun

`bun create ndxbn/bun .` is my bun application boilerplate
https://github.com/ndxbn/bun

bun bun-boilerplate bun-template

Last synced: 5 months ago
JSON representation

`bun create ndxbn/bun .` is my bun application boilerplate

• Host: GitHub
• URL: https://github.com/ndxbn/bun
• Owner: ndxbn
• License: mit
• Created: 2024-08-16T07:56:33.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2025-12-17T18:11:51.000Z (6 months ago)
• Last Synced: 2025-12-21T06:42:15.869Z (6 months ago)
• Topics: bun, bun-boilerplate, bun-template
• Language: TypeScript
• Homepage:
• Size: 894 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          

#

[![Bun](https://img.shields.io/badge/Bun-000000?logo=bun&logoColor=white&labelColor=grey)](https://bun.sh/)

[![Formatted and Linted with Biome](https://img.shields.io/badge/Biome-60a5fa?logo=biome&labelColor=grey)](https://biomejs.dev/)

[![Lefthook](https://img.shields.io/badge/Lefthook-ff1e1e?logo=Lefthook&logoColor=ff1e1e&labelColor=grey)](https://lefthook.dev/)

This project is created by `bun create ndxbn/bun`.

- TypeScript config is based on "strictest"

- Dockerfile for production, docker-compose for development

- Entrypoint files

  - [index.ts](./src/index.ts): `import from "THIS_REPO"` from outside

  - [cli.ts](src/cli.ts): `bun cli`

  - [server.ts](src/server.ts): `bun start`

## Requirements

- [Bun](https://bun.sh/)

- [Docker](https://docker.com/) or [podman](https://podman.io/)

## Getting Start

```bash

# clone this repository

git clone XXX

cd XXX

# install dependencies

bun install

# setup development environment, initialize application

bun dev

# run middleware

docker compose up -d # or `podman compose up -d`

# run CLI application

bun cli -h

#   or start server

bun start

```

## Testing

```bash

bun test

```

## What to use Docker

- startup Middlewares

- [lint GitHub Action](./.github/lint.compose.yaml): do `cd .github` before run it