Boas-vindas ao repositório Book Manager!

Documentação feita no Swagger:

http://localhost:3000/documentation/

Projeto

O que foi desenvolvido ?

Neste projeto foi desenvolvido uma API e um banco de dados para a gestão de livros lidos!

Essa aplicação utiliza: docker, docker compose, mySQL, typescript, node, express, swagger, eslint

Orientações

Rodando no Docker vs Localmente

Com Docker

⚠️ Antes de começar, seu docker-compose precisa estar na versão 1.29 ou superior. Veja aqui ou na documentação como instalá-lo. No primeiro artigo, você pode substituir onde está com 1.26.0 por 1.29.2.

ℹ️ Rode os serviços node e db com o comando docker-compose up -d --build.

• Lembre-se de parar o mysql se estiver usando localmente na porta padrão (3306), ou adapte, caso queria fazer uso da aplicação em containers;

• Esses serviços irão inicializar um container chamado book_manager_container e outro chamado book_manager_db;

• A partir daqui você pode rodar o container book_manager_container via CLI ou abri-lo no VS Code;

ℹ️ Use o comando docker exec -it book_manager_container sh.

• Ele te dará acesso ao terminal interativo do container criado pelo compose, que está rodando em segundo plano.

Sem Docker

ℹ️ Instale as dependências [Caso existam] com npm install

• ✨ Dica: Para rodar o projeto desta forma, obrigatoriamente você deve ter o node instalado em seu computador.

🎛 Linter

Para garantir a qualidade do código, foi usado o ESLint para fazer a sua análise estática.

Para poder rodar os ESLint em um projeto basta executar o comando npm install dentro do projeto e depois npm run lint. Se a análise do ESLint encontrar problemas no seu código, tais problemas serão mostrados no seu terminal. Se não houver problema no seu código, nada será impresso no seu terminal.

Você também pode instalar o plugin do ESLint no VSCode, bastar baixar o plugin ESLint e instalá-lo