https://github.com/batuhankorur/bun-boilerplate

Starter template for building web apps/services via bun.js!
https://github.com/batuhankorur/bun-boilerplate

boilerplate bun eslint typescript

Last synced: 7 days ago
JSON representation

Starter template for building web apps/services via bun.js!

• Host: GitHub
• URL: https://github.com/batuhankorur/bun-boilerplate
• Owner: BatuhanKorur
• License: mit
• Created: 2024-12-28T17:38:30.000Z (9 days ago)
• Default Branch: main
• Last Pushed: 2024-12-28T17:52:24.000Z (8 days ago)
• Last Synced: 2024-12-28T18:25:57.613Z (8 days ago)
• Topics: boilerplate, bun, eslint, typescript
• Language: TypeScript
• Homepage:
• Size: 0 Bytes
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# 🥟 Bun Boilerplate

This is a starter template for building web applications and services using Bun.js.

## 🚀 Getting Started

1. **Clone the repository:**

   ```bash

   git clone https://github.com/BatuhanKorur/bun-boilerplate

   cd bun-boilerplate

   ```

2. **Install dependencies:**

   ```bash

   bun install

   ```

3. **Start the development server:**

   ```bash

   bun dev

   ```

## 📂 Features

- **Configured ESLint:** Includes recommended stylistic rules.

- **Alias setup:** `src` directory is accessible via `@`.

- **Centralized Config:** Store key configuration values in `@/core/config`.

- **Health Check:** A built-in `/ping` route to verify server status.

- **Error Handling:** Pre-configured error handler middleware.

## 🤝 Contributions

Contributions are welcome! Feel free to [open an issue](https://github.com/BatuhanKorur/bun-boilerplate/issues) or submit a pull request.

## 📄 License

This project is licensed under the [MIT License](LICENSE.md).

---

Happy coding! 🎉