frank.gairal.rocks RESTful API

A REST API built with TypeScript, Koa, Vitest, bun, biome and ❤️

TOC

• Quick Start
• Commands
• To-do

Quick Start

# clone the repo
git clone git@github.com:gairal/frank-bo-node.git

# enter the repo directory
cd frank-bo-node

# install the dependencies
bun i

# start the ts-node-dev process
bun start

# access the API on http://localhost:8000

Commands

• bun run build: builds the app for production
• bun dev: launches a ts-node-dev watcher
• bun lint: lints the whole sources and tests with eslint
• bun start: runs the project in production mode
• bun test-cov: runs vitest tests with coverage
• bun run test: runs vitest tests

To-do

• add lru-cache + reset endpoint?