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

https://github.com/danielfsousa/desafio-jazida


https://github.com/danielfsousa/desafio-jazida

Last synced: 27 days ago
JSON representation

Awesome Lists containing this project

README

          

# Desafio Jazida.com
[![Build Status](https://travis-ci.org/danielfsousa/desafio-jazida.svg?branch=master)](https://travis-ci.org/danielfsousa/desafio-jazida) [![Coverage Status](https://coveralls.io/repos/github/danielfsousa/desafio-jazida/badge.svg?branch=master)](https://coveralls.io/github/danielfsousa/desafio-jazida?branch=master)

## Documentação

[**https://desafio-jazida.herokuapp.com/documentacao**](https://desafio-jazida.herokuapp.com/documentacao)

## Requisitos

- [Node v8+](https://nodejs.org/en/download/current/) ou [Docker](https://www.docker.com/)
- NPM ou Yarn

## Instruções

```bash
# Clone o repositorio
git clone https://github.com/danielfsousa/desafio-jazida

# Instale as dependências
npm install

# Crie um arquivo .env e modifique as variaveis de ambiente
cp .env.example .env
nano .env

# Inicie no modo Desenvolvimento
npm run dev

# Inicie no modo Produção
npm start
```

## Scripts

```bash
npm start # Inicia no modo Produção
npm test # Inicia testes
npm run dev # Inicia no modo de Desenvolvimento
npm run lint # Analisa o código
npm run lint:fix # Analisa o código e tenta consertar automaticamente
npm run lint:watch # Analisa o código e mantém a verificação de mudanças no código
npm run test:unit # Inicia testes unitários
npm run test:watch # Inicia testes unitários e mantém a verificação de mudanças no código
npm run test:integration # Inicia teste de integração
npm run validate # Analisa o código e Inicia testes
npm run logs # Lista todos os logs
npm run logs:error # Lista logs com erros
npm run docs # Gera a documentação da API
npm run docker:start # Inicia com o Docker no modo Produção
npm run docker:dev # Inicia com o Docker no modo Desenvolvimento
npm run docker:test # Inicia testes com o Docker
```