https://github.com/leosuncin/koa-api-example

A simple REST API built with Koa
https://github.com/leosuncin/koa-api-example

jest koa nodejs pactum rest-api typeorm typescript

Last synced: 3 months ago
JSON representation

A simple REST API built with Koa

• Host: GitHub
• URL: https://github.com/leosuncin/koa-api-example
• Owner: leosuncin
• Created: 2021-10-06T06:28:57.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-10-07T15:22:53.000Z (4 months ago)
• Last Synced: 2024-10-09T22:08:12.693Z (4 months ago)
• Topics: jest, koa, nodejs, pactum, rest-api, typeorm, typescript
• Language: TypeScript
• Homepage:
• Size: 26 MB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# 🌲 Koa API example

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

[![GPLv3 License](https://img.shields.io/badge/License-GPL%20v3-green.svg)](http://www.gnu.org/licenses/gpl-3.0)

> A simple REST API built with Koa

## Tech Stack

**Server:** Node, Koa, TypeORM

**Test:** Jest, Pactum

## Run Locally

Clone the project

```bash

  git clone https://github.com/leosuncin/koa-api-example.git

```

Go to the project directory

```bash

  cd koa-api-example

```

Install dependencies

```bash

  npm install

```

Build the project

```bash

  npm run build

```

Start the server

```bash

  npm start

```

## Running Tests

To run unit tests, run the following command:

```bash

  npm test

```

## License

Release under the terms of [GPL v3](http://www.gnu.org/licenses/gpl-3.0)