Skip to content

ianlcz/flood-api

Repository files navigation

Flood API

It was built using NestJS framework, which allows building efficient, reliable and scalable server-side applications.

Development Team

Built with

Installation

You can install the project by cloning this repository:

git clone https://github.com/ianlcz/flood-api.git

Install dependencies

First of all, if you have just cloned the repository you have to install the project dependencies with the command npm install in the root folder.

Usage

Running

# development mode
$ npm run start

# watch mode
$ npm run start:dev

Testing

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

About

REST API developed with NestJS that provides real-time river levels and flood risk thresholds based on hydrological data.

Resources

License

Stars

Watchers

Forks

Contributors