Este projeto foi desenvolvido como parte do processo seletivo para a vaga de Dev Backend na FCamara. O objetivo do projeto é demonstrar habilidades em desenvolvimento de backend, integração com MySQL, testes unitários e documentação via Swagger.
- Nest.js 10.4.5: Framework para construção de APIs robustas em Node.js.
- Node.js 20.15.1: Ambiente de execução JavaScript no servidor.
- Yarn 1.22.22: Gerenciador de pacotes.
- MySQL: Banco de dados relacional.
- Docker: Usado para orquestrar o banco de dados MySQL.
- Swagger: Para documentação interativa da API.
- Vitest 3.0.2: Framework de testes para realizar testes unitários.
- Node.js: versão 20.15.1
- Yarn: versão 1.22.22
- Docker: para rodar o banco de dados MySQL
Certifique-se de ter o Docker instalado e funcionando. Para inicializar o banco de dados MySQL via Docker, execute o comando:
docker compose upCaso não tenha a versão do node instalada, digite o seguinte comando no terminal
docker pull node:20.18-alpineO docker-compose irá configurar e iniciar uma instância do MySQL automaticamente. A configuração do banco de dados está definida no arquivo database.sql, que contém todas as tabelas e inserções necessárias para rodar a aplicação corretamente.
Primeiro garanta a existencia deu m banco de dados MySQL e que as váriaveis estejam em um arquivo .env com os mesmos nomes do arquivo process-local.env
Após garantir que o banco de dados esteja em execução, instale as dependências do projeto utilizando o Yarn:
yarn installApós a instalação das dependências, inicie o servidor Nest.js com o comando:
bash Copiar código
yarn startA documentação da API foi configurada utilizando o Swagger. Para acessá-la, basta navegar até a seguinte URL no seu navegador:
http://localhost:3000/api-docsPara executar os testes unitários da service, execute o seguinte comando:
yarn test