Este projeto foi desenvolvido para a disciplina de Back-End Frameworks do curso de Ciência da Computação na UNINASSAU, sob a orientação do professor João Ferreira. O objetivo principal é implementar uma API RESTful para a gestão de bibliotecas, permitindo o controle eficiente de livros, leitores e transações de empréstimo.
- CRUD de Livros: Gerenciamento de livros com informações como título, autor, gênero e ano de publicação.
- CRUD de Usuários: Registro de usuários com campos para nome, endereço, e-mail e telefone.
- Gestão de Empréstimos: Controle de empréstimos e devoluções, com limite de livros por usuário e datas de devolução.
- Geração de Relatórios: Relatórios que incluem os livros mais emprestados e usuários com pendências.
Certifique-se de ter as seguintes ferramentas instaladas:
-
Clone o Repositório:
git clone https://github.com/Pedroka72/LibraryApi.git cd Libraryapi -
Instale as Dependências:
npm install express mysql2 sequelize dotenv body-parser nodemon
-
Crie um banco de dados chamado libraryapi no MySQL. Copie o arquivo .env.example para .env e ajuste as credenciais conforme seu ambiente MySQL: makefile
DB_HOST=localhost DB_USER=seu_usuario DB_PASSWORD=sua_senha DB_NAME=libraryapi DB_PORT=3306 DB_DIALECT=mysql
-
Pronto! Agora você está pronto para contribuir com o projeto.
| Ferramenta | Descrição |
|---|---|
| Git | Controle de versão |
| Node.js | Ambiente de execução JavaScript |
| MySQL | Sistema de gerenciamento de banco de dados |
| Express | Framework de aplicação web |
| mysql2 | Driver para conexão com MySQL |
| Sequelize | ORM para MySQL |
| body-parser | Middleware para processar corpos de requisições HTTP, permitindo acessar dados enviados via JSON ou formulário |
| Nodemon | Reinicia automaticamente o aplicativo node quando alterações de arquivo no diretório são detectadas. |
Passos para Contribuir
- Crie uma Branch:
git checkout -b sua-branch
- Atualize sua Branch:
Copiar código
git checkout main
git pull origin main
git checkout sua-branch
git merge main- Faça Alterações e Commits:
git add .
git commit -m "Descrição das alterações"
- Sincronize com a Branch Principal:
git checkout main
git pull origin main
git checkout sua-branch
git merge main- Envie sua Branch:
Copiar código
git push origin sua-branch
- Crie um Pull Request:
Abra um Pull Request no GitHub para revisão e merge.
| Nome | Função |
|---|---|
| João Pedro silva de araujo | Desenvolvedor |
| William coelho de Morais | Scrum Master |
| Gabriel araujo farias de santana | Desenvolvedor |
| Gabriel George de Araújo Figueredo | Gerente de Configuração |
| Rodolpho Dihego Freire Da Rocha Filho | Documentador |
| João Gunttemberg de Almeida Coimbra | Documentador |
Este projeto está licenciado sob a Creative Commons CC0 1.0 Universal. Para mais informações, consulte o arquivo LICENSE