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

💡Simple energy usage API built using Node.js, TypeScript & Koa
https://github.com/paambaati/reading-between-the-lines

bulb coding-challenge interview-questions koa koa2 nodejs typescript

Last synced: about 2 months ago
JSON representation

💡Simple energy usage API built using Node.js, TypeScript & Koa

• Host: GitHub
• URL: https://github.com/paambaati/reading-between-the-lines
• Owner: paambaati
• License: wtfpl
• Created: 2019-08-05T11:14:19.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-23T23:49:50.000Z (about 2 years ago)
• Last Synced: 2024-12-03T15:24:52.906Z (2 months ago)
• Topics: bulb, coding-challenge, interview-questions, koa, koa2, nodejs, typescript
• Language: TypeScript
• Homepage:
• Size: 949 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# reading-between-the-lines

[![Build Status](https://github.com/paambaati/reading-between-the-lines/workflows/PR%20Checks/badge.svg)](https://actions-badge.atrox.dev/paambaati/reading-between-the-lines/goto) [![Test Coverage](https://api.codeclimate.com/v1/badges/fb77b0efca00f8789f5a/test_coverage)](https://codeclimate.com/github/paambaati/reading-between-the-lines/test_coverage) [![Maintainability](https://api.codeclimate.com/v1/badges/fb77b0efca00f8789f5a/maintainability)](https://codeclimate.com/github/paambaati/reading-between-the-lines/maintainability) [![WTFPL License](https://img.shields.io/badge/License-WTFPL-blue.svg)](LICENSE)

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](PROBLEM-STATEMENT.md)).

### 🛠️ Setup

```bash

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

cd reading-between-the-lines

yarn install

yarn build

```

#### 👩🏻‍💻 Usage

```bash

yarn start

```

For debugging in watch-mode with additional logs, use —

```bash

yarn debug

```

#### 🧪 Tests & Coverage

```bash

yarn run coverage

```

### 🚀 Postman

Once the API is up, import the [`api.postman_collection.json`](https://raw.githubusercontent.com/paambaati/reading-between-the-lines/master/api.postman_collection.json) file in Postman to test the APIs.