reading-between-the-lines

πŸ’‘Simple energy usage API built using Node.js, TypeScript & Koa

WTFPL License

Stars
0

reading-between-the-lines

A simple API server that lets users access and add meter readings.

The API also extrapolates meter readings to guesstimate the end-of-month cumulative readings.

πŸ“£ Note that this project was purpose-built for a coding challenge (see problem statement).

πŸ› οΈ Setup

git clone https://github.com/paambaati/reading-between-the-lines
cd reading-between-the-lines

yarn install
yarn build

πŸ‘©πŸ»β€πŸ’» Usage

yarn start

For debugging in watch-mode with additional logs, use β€”

yarn debug

πŸ§ͺ Tests & Coverage

yarn run coverage

πŸš€ Postman

Once the API is up, import the api.postman_collection.json file in Postman to test the APIs.

Badges
Extracted from project README
Build Status Test Coverage Maintainability WTFPL License