Bun starter

Key Features

• TypeScript
  • Typed environment variables
• Bun
  • Debugging
  • ESM & CommonJS compatibility
  • Fast package manager
  • Fast runtime
  • Fast test runner
  • Highly optimized APIs
  • Hot reloading
  • TypeScript first class support
• Biome
  • Fast formatting
  • Fast linting
  • Import sorting
• GitHub
  • One click template
  • Continuous Integration

Prerequisites

• Bun >=1.0.0
  • All-in-one toolkit
  • JavaScript runtime
  • Package manager
  • Test runner
  • Bundler

Getting Started

1. Deploy on Railway or use this template

2. Clone the repository

3. Install dependencies

   bun i

4. Typecheck environment variables

   .env

   PORT=3000

   src/env.ts (docs)

   export default arkenv({
     PORT: "number.port",
   });

Usage

• Development mode

  bun dev

• Development debug mode (VSCode)

  F5

• Running tests (watch mode)

  bun test --watch

• Production build

  bun run build