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

https://github.com/fernandohenriques/mercado-livre-clone-api

API for Mercado Livre short app clone.
https://github.com/fernandohenriques/mercado-livre-clone-api

axios eslint express joi nodejs ramda

Last synced: about 2 months ago
JSON representation

API for Mercado Livre short app clone.

Awesome Lists containing this project

README

        

# Mercado Livre App Api (BFF for [this](https://github.com/fernandohenriques/mercado-livre-clone.git) front-end)

## Getting Started

JavaScript + Node.js + Express + Joi + Ramda + Husky + ESLint = :muscle:

### Pré-requisitos

```
$ Git --version
>= v2.19

$ node --version
>= v10.11.0

$ NPM --version
>= v6.4.1

```

### How to run

```
Pelo terminal, entre na pasta onde deseja manter o projeto e execute os seguintes passos:

$ git clone https://github.com/fernandohenriques/mercado-livre-clone-api.git
$ cd mercado-livre-clone-api/
$ cp .env.sample .env
$ npm install
$ npm run dev
```

### To run in Prod

```
$ cd mercado-livre-clone-api/
$ npm install
$ npm run start
```

### Run tests

```
$ cd mercado-livre-clone-api/
$ npm run test:unit
```

### Static Analysis

```
$ cd mercado-livre-clone-api/
$ npm run test:lint
```

### Code Coverage

```
$ cd mercado-livre-clone-api/
$ npm run test:coverage
```

## Built With

* [Node.js](https://nodejs.org/)
* [Express](https://expressjs.com)
* [Ramda](https://ramdajs.com/)
* [Joi](https://github.com/hapijs/joi)
* [Axios](https://github.com/axios/axios)
* [Morgan](https://github.com/expressjs/morgan)
* [NPM](https://yarnpkg.com/)
* [ESLint](https://eslint.org/)
* [Husky](https://github.com/typicode/husky)
* [Lint Staged](https://github.com/okonet/lint-staged)

## Author

* **Fernando Henriques** - [GitHub](https://github.com/fernandohenriques)