https://github.com/rohenaz/1sat-api

https://github.com/rohenaz/1sat-api

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/rohenaz/1sat-api
• Owner: rohenaz
• Created: 2024-01-18T11:25:30.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-08-13T00:29:14.000Z (3 months ago)
• Last Synced: 2024-08-13T02:13:22.840Z (3 months ago)
• Language: TypeScript
• Size: 332 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Bun + TypeScript starter

![](../../actions/workflows/ci.yml/badge.svg)

[![](https://railway.app/button.svg)](https://railway.app/template/G3k1Tv?referralCode=bonus)

## Key Features

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

  - [Debugging](.vscode/launch.json)

  - [ESM & CommonJS compatibility](https://bun.sh/blog/bun-v1.0#esm-commonjs-compatibility)

  - [Fast package manager](https://bun.sh/blog/bun-v1.0#install-speeds)

  - [Fast runtime](https://bun.sh/blog/bun-v1.0#speed)

  - [Fast test runner](https://bun.sh/blog/bun-v1.0#bun-is-a-test-runner)

  - [Highly optimized APIs](https://bun.sh/blog/bun-v1.0#bun-apis)

  - [Hot reloading](https://bun.sh/docs/runtime/hot#hot-mode)

  - [TypeScript first class support](https://bun.sh/docs/runtime/typescript)

- [ Biome](https://biomejs.dev/)

  - [Fast formatting](https://github.com/biomejs/biome/tree/main/benchmark#formatting)

  - [Fast linting](https://github.com/biomejs/biome/tree/main/benchmark#linting)

  - [Import sorting](https://biomejs.dev/analyzer/#imports-sorting)

- [ GitHub](https://github.com)

  - [One click template](https://github.com/dayblox/bun-ts/generate)

  - [Continuous Integration](.github/workflows/ci.yml)

## Prerequisites

- [ Bun](https://bun.sh/) `>=1.0.0`

  - [All-in-one toolkit](https://bun.sh/blog/bun-v1.0#bun-is-an-all-in-one-toolkit)

  - [JavaScript runtime](https://bun.sh/blog/bun-v1.0#bun-is-a-javascript-runtime)

  - [Package manager](https://bun.sh/blog/bun-v1.0#bun-is-a-package-manager)

  - [Test runner](https://bun.sh/blog/bun-v1.0#bun-is-a-test-runner)

  - [Bundler](https://bun.sh/blog/bun-v1.0#bun-is-a-bundler)

## Getting Started

1.  **[Deploy on Railway](https://railway.app/template/G3k1Tv?referralCode=bonus)** or **[use this template](https://github.com/dayblox/bun-ts/generate)**

2.  **Clone** the repository

3.  **Install** dependencies

    ```sh

    bun i

    ```

## Usage

- **Development** mode (**debug**)

  `F5`

- Running **tests** (**watch** mode)

  ```sh

  bun test --watch

  ```

- **Production** mode

  ```sh

  bun start

  ```