README.md

C-OUL

Sobre • Endpoints • ER • Como executar • Testes •

💻 Sobre o projeto

A API permite criar usuários e associa-los a uma cidade. Neste projeto foram usandos alguns frameworks como forma de consolidar os estudos e testar diferentes cenários.

---

🛠 Endpoints

🎨 Modelo Relacional

---

🚀 Como executar o projeto

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js e Docker. Além disto é bom ter um editor para trabalhar com o código como VSCode

Rodando a aplicação pelo docker:

Instalando as dependências

Criando o container

docker-compose up --build

Automaticamente as dependências serão baixadas, o clinte do prisma será gerado automaticamente e as migrations serão executadas. Por padrão, a aplicação estará disponível no endereço http://localhost:3333

Rodando a aplicação sem o docker

Instale as dependências

yarn

Crie um banco de dados e altere as credenciais de acesso no .env.development

postgresql://username:password@host/database?schema=public

Execute a aplicação

yarn dev

🚀 Como executar os testes

Por existirem testes de integração, é necessário um banco de testes.

Crie um banco de dados e altere as credenciais de acesso no .env.test

postgresql://username:password@host/database?schema=public

Execute os testes

yarn test