Uma API de cadastro de restaurantes e pratos.

Tabela de Conteúdos

1. Pré-requisitos
2. Clonando o repositório
3. Testes unitários
4. Acessando a documentação
5. Tecnologias utilizadas
6. Contato

Pré-requisitos

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

Também será necessário a conexão com um banco de dados postgres. Você pode alterar os parâmetros de conexão no arquivo "ormconfig.json" que está na raiz do projeto. Caso você tenha o docker instalado em sua máquina pode executar o seguinte comando na raiz do projeto para subir um container com a base de dados já criada.

$ docker-compose up -d

Clonando o repositório

# Clone este repositório
$ git clone https://github.com/alisson-moura/uai-food

# Acesse a pasta do projeto no terminal/cmd
$ cd uai-food

# Instale as dependências
$ npm install

Após clonar e instalar as dependências do projeto é necessário rodar as migrations para criar as tabelas no banco de dados, então após subir o banco de dados postgres com a base de dados uai_food criada, executar o seguinte comando:

$ npm run typeorm migration:run

E para iniciar a aplicação:

$ npm start

A API ficara disponível no endereço "http://localhost:8000".

Testes unitários

A api tem uma cobertura de testes unitários, para rodar os testes basta executar:

npm run test

Acessando a documentação

A documentação da aplicação contém os dados necessários para usar corretamente os endpoints, para visualizar a documentação basta acessar no seu navegador: http://localhost:8000/

Tecnologias utilizadas

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

• Node.js
• TypeScript
• TypeOrm
• Swagger

Contato

Alisson Moura 👋🏽 Entre em contato!