MELI - Product Finder API

Description

This project is a BFF for this Frontend.

Prerequisites

$ git >= v2.x
$ npm >= v6.x
$ nodejs >= v10.x

Installation and Getting Started

1. Clone this repository:

$ git clone https://github.com/alan-nascimento/meli-product-finder-api.git

2. Install dependencies:

$ npm install

3. Create an .env file in the root folder and set the environment variables following the .env.example file.

4. Start the local server:

$ npm run dev

Running unit testing

1. Open a new terminal execute:

$ npm run test

3. Run the following command to collect coverage report:

$ npm run test:ci

Running Linter

1. Run the following command at the terminal:

$ npm run lint

Production Build

1. Run the following command:

$ npm run build

2. The build result will be avaiable at the dist folder.

Libraries and Tools

• Node.js
• TypeScript
• Axios
• Jest
• Git
• NPM
• Coveralls
• Husky
• Lint Staged
• ESLint
• Prettier

Author & Version Control

Developed by Alan Nascimento - Github - Published in October of 2020.