An open API service indexing awesome lists of open source software.

https://github.com/leosuncin/fastify-example

A simple REST API built with Fastify
https://github.com/leosuncin/fastify-example

api-rest ava fastify nodejs pactum

Last synced: 2 months ago
JSON representation

A simple REST API built with Fastify

Awesome Lists containing this project

README

          

# ⚡ Fastify example

[![Continuos Integration](https://github.com/leosuncin/fastify-example/actions/workflows/ci.yml/badge.svg)](https://github.com/leosuncin/fastify-example/actions/workflows/ci.yml)
[![CodeFactor](https://www.codefactor.io/repository/github/leosuncin/fastify-example/badge?s=10bbca5395c32ef18b94c9325f528cb604986217)](https://www.codefactor.io/repository/github/leosuncin/fastify-example)
[![GPLv3 License](https://img.shields.io/badge/License-GPL%20v3-green.svg)](http://www.gnu.org/licenses/gpl-3.0)

> A simple REST API implemented with Fastify

## Tech Stack

**Server:** Node, Fastify

**Test:** AVA, Pactum

## Run Locally

Clone the project

```bash
git clone https://github.com/leosuncin/fastify-example.git
```

Go to the project directory

```bash
cd fastify-example
```

Install dependencies

```bash
npm install
```

Start the server

```bash
npm start
```

## Running Tests

To run unit tests, run the following command:

```bash
npm test
```

To run e2e tests, first run the server in background and then run the following command:

```bash
npm run test:e2e
```

## License

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