Currency Converter BFF

This repository hosts the BFF application of the Currency Converter tool.

Table of Contents

1. Introduction
2. Deployment Guide
   • How to Checkout
   • How to Build
   • How to Run Locally
   • How to Run Unit Tests
3. Features

Introduction

Component Type
Rest API

Dependencies

• Express
• Axios
• Config
• Cors
• Express Rate Limit
• JSON Web Token

Deployment Guide

How to Checkout

Checkout the codebase from GitHub:

$ git clone https://github.com/lochanar/currency-converter-bff.git
cd currency-converter-bff

How to Build

Run the following command in order to generate an optimized production build of the app.

$ yarn build

How to Run Locally

Development Mode

The package manager used in this project is yarn. To install yarn, you can follow the official guide.

Once yarn is installed, navigate to the project root and execute the following command:

$ yarn

This will initialize and install all the required dependencies.

In order to run the app in the development mode:

$ yarn start

Visit http://localhost:3001/api-docs/ in the browser to visit the swagger doc!