caiovinicius7 / teste-mevo-backend Goto Github PK

Essa API é projeto utilizado como teste técnico de backend para vaga de desenvolvedor fullstack na Mevo.

O sistema conta com as seguintes funcionalidades:

• Listagem de clients
• Listagem de produtos
• Listagem de produto por id
• Criação de pedido

Caso queira ver as funcionalidades por completo e de modo técnico acesse a documentação do projeto (clique aqui para ver como acessá-la).

Antes de começar, você vai precisar ter instalado em sua máquina: Node, Git, Docker e Insominia ou Postman.

# Clone este repositório
$ git clone https://github.com/CaioVinicius7/teste-mevo-backend.git

# Acesse a pasta do projeto no terminal/cmd
$ cd teste-mevo-backend

# Acesse o projeto pelo vs code
$ code .

# crie o arquivos .env e o preencha seguindo o aquivo .env.example

# Baixe as dependências
$ yarn ou npm install

# Faça o build dos containers
$ docker-compose build

# Execute os containers
$ docker-compose up -d

# Rode as migrations
$ yarn prisma migrate deploy ou npx prisma migrate deploy

# Rode as seeds
$ yarn prisma db seed ou npx prisma db seed

# Rode o servidor
$ yarn dev ou npm run dev


# O servidor ficara ativo na porta definida no arquivo .env - acesse <http://localhost:{port}/api>

Para rodar os testes rode o script test:before após ter rodado os containers, para executar as migrations e as seeds no container que será utilizado para rodar os testes e depois rode o script test para executar os testes.

Obs: Rode o script test:before todas vezes que queira rodar novamente as migrations ou as seeds no container de testes devido a alguma alteração ou algo do tipo.

Para ter acesso a documentação utilize a rota /api-docs após a inicialização da aplicação.

http://localhost:{port}/api-docs/