Documentação da API

Tabela de Conteúdos

1. Visão Geral

Visão geral do projeto, um pouco das tecnologias usadas.

A URL base da aplicação:

https://project-m4-backend-rpgencounter.onrender.com

2. Diagrama ER

Voltar para o topo

Diagrama ER da API definindo bem as relações entre as tabelas do banco de dados.

3. Documentação

Voltar para o topo

Link com a Documentação

4. Rodando localmente

Voltar para o topo

4.1 Instale as dependências

Clone o projeto em sua máquina e instale as dependências com o comando:

  yarn

4.2 Variáveis de Ambiente

Em seguida, crie um arquivo .env, copiando o formato do arquivo .env.example:

  cp .env.example .env

4.3 Migrations

Execute as migrations com o comando:

  yarn typeorm migration:run -d src/data-source.ts