Descrição 🚀 • Pré-requisitos 🛠️ • Instalação Back-end 🚀 • Instalação Front-end 🚀 • Contribuições 🤝
Este é um projeto full stack que utiliza o framework NestJS para o back-end, MySQL como banco de dados e Swagger para a documentação da API. Além disso, foram implementados testes unitários para os serviços (services) e controladores (controllers) da API. O front-end foi desenvolvido em React.Certifique-se de ter instalados antes de executar o projeto:
- Node.js - (v.20.10.0)
- npm - (v.10.2.3)
- MySQL Server
1. Clone este repositório para o seu ambiente local.
- Navegue até a pasta back-end e execute o seguinte comando para instalar as dependências (Node 20):
npm install
- Inicie o servidor NestJS com o seguinte comando:
npm start
- Crie um banco de dados MySQL para o projeto;
- Atualize as configurações do banco de dados no arquivo .env na raiz da pasta back-end;
DB_HOST=
DB_PORT=
DB_DATABASE=
DB_USERNAME=
DB_PASSWORD=
A documentação da API está disponível através do Swagger. Após iniciar o servidor, acesse http://localhost:3000/swagger para explorar e interagir com a API.
Foram implementados testes unitários para garantir a integridade dos serviços e controladores. Execute os testes com o seguinte comando:
npm run test
1. Navegue até a pasta front-end e execute o seguinte comando para instalar as dependências (Node 20):
npm install
- Inicie o servidor:
npm start
O aplicativo React estará disponível em http://localhost:3000.
Sinta-se à vontade para contribuir para este projeto. Se você encontrar problemas ou tiver sugestões de melhorias, abra uma issue ou envie um pull request.