enoquebsf/gestao-contratos-api

Sistema de gestão de contratos - API

Features

• Autenticação JWT
• Cadastro de Prestadores de Serviço
• Cadastro de Contratos
• Dashboard (Em desenvolvimento)

🛠 Documentação

Documentação da API com Swagger.

🛠 Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

• Node.js
  • Express
  • Typeorm
  • Tsyring
  • Jest (Testes unitarios - Coverage: 90%)
• TypeScript

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js Yarn Docker

🎲 Rodando o BackEnd (servidor)

# Clone este repositório
$ git clone <https://github.com/carlosajr/gestao-contratos-api.git>

# Acesse a pasta do projeto no terminal/cmd
$ cd gestao-contratos-api

# Instale as dependências
$ yarn

# Configuração das variaves de ambiente copiando de .env.example
$ cp .env.example .env

# Configuração dos dados do banco de dados
É necessario preencher as informações de: host, usuario, senha e nome do banco em ormconfig.json

# Execute a aplicação em modo de desenvolvimento
$ yarn dev 

# O servidor inciará na porta:3333 - acesse <http://localhost:3333>

# Para executar em Produção
$ sudo docker-compose up --build -d

# O servidor inciará na porta:3333 - acesse <http://localhost:3333>