frank.gairal.rocks RESTful API

A REST API built with TypeScript, Koa, Jest, Prettier, eslint 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
yarn

# start the ts-node-dev process
yarn start

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

Commands

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

To-do

• add lru-cache + reset endpoint?