/cryptocurrencies-comparator

Primary LanguageTypeScript

Cryptocurrencies Comparator

Description

An API that return real time price of cryptocurrencies

Docs generated by open api (swagger).

The api already deploy on heroku. You can check the endpoints on the following links:

  1. get available cryptocurrencies: https://rocky-tor-65439.herokuapp.com/currencies/crypto

  2. get available fiat currencies: https://rocky-tor-65439.herokuapp.com/currencies/fiat

  3. get real time price of a cryptocurrency: https://rocky-tor-65439.herokuapp.com/prices/?fiat=USD,EUR&crypto=BTC,ETH

You can also run the tests and install it on your local machine (instructions on the readme file)

Installation

$ npm install

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

Alternative way, install and run the using Docker Compose

# build the image
$ docker-compose -f docker-compose.yml build  

# build the container
$  docker-compose -f docker-compose.yml up -d

Test

# unit tests
$ npm run test