Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tomaz-arlindo/libraryapi
https://github.com/tomaz-arlindo/libraryapi
api-rest docker springboot
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/tomaz-arlindo/libraryapi
- Owner: Tomaz-Arlindo
- License: gpl-3.0
- Created: 2024-11-19T01:43:36.000Z (about 2 months ago)
- Default Branch: master
- Last Pushed: 2024-11-29T23:54:29.000Z (about 1 month ago)
- Last Synced: 2024-11-30T00:25:56.527Z (about 1 month ago)
- Topics: api-rest, docker, springboot
- Language: Dockerfile
- Homepage:
- Size: 41.1 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LibraryApi
### Sumário:
* [Descrição](#descrição)
* [Como baixar o repositório](#como-baixar-o-repositório)
* [Pré-requisitos](#pré-requisitos)
* [Contribuindo](#contribuindo)
* [Autores](#autores)
* [Licença](#licença)
## Descrição
Este é um sistema de gerenciamento de biblioteca, projetado para facilitar o controle de livros, usuários e empréstimos. A aplicação foi construída com **Spring Boot**, utiliza **MySQL** como banco de dados e está totalmente conteinerizada com **Docker**, permitindo fácil implantação em qualquer ambiente que suporte containers.
### Funcionalidades principais
- Cadastro de livros, usuários e empréstimos.
- Gerenciamento e histórico de devoluções.
- Validação e tratamento de erros HTTP.
- Conteinerização completa com suporte a ambientes multi-plataforma.
## **Como baixar o repositório**
1. Clone este repositório:
```bash
git clone https://github.com/Tomaz-Arlindo/LibraryApi.git
```
2. Navegue até o diretório onde se encontra o *docker-compose.yml*
```bash
cd LibraryApi/libraryapi
```
## **Pré-requisitos**
Você precisará instalar os seguintes programas para rodar o projeto:
- **Docker** e **Docker Compose**
- **Java 21+**
### **Instalação no Linux (Fedora)**
1. Instale o Docker e o Compose:
```bash
sudo dnf install -y docker-ce docker-compose-plugin
```
2. Inicie o Docker:
```bash
sudo systemctl start docker
```
3. Verifique a versão do Java:
```bash
java --version
```
(Se necessário, instale o Java com `sudo dnf install java-21-openjdk`)
### **Instalação no Windows**
1. Baixe e instale o **Docker Desktop** :
- Acesse [Docker Desktop](https://www.docker.com/products/docker-desktop/) e faça o download.
2. Certifique-se de ativar a opção para usar o WSL2 durante a instalação.
3. Instale o **Java 21**:
- Baixe o instalador do OpenJDK 21 no site oficial: [OpenJDK Downloads](https://jdk.java.net/21/)
- Após a instalação, verifique a versão no terminal ou PowerShell:
```bash
java --version
```
## **Como rodar o projeto**
1. No diretório "libraryapi" do projeto, configure os containers com:
```bash
docker compose up --build -d
```
2. A aplicação estará disponível em:
`http://localhost:8080`
3. Utilize um programa de requisições de sua preferência ([Postman](https://www.postman.com), [Insomnia](https://insomnia.rest/download), etc)
## Contribuindo
[Sabia como contribuir](https://github.com/Tomaz-Arlindo/LibraryApi/blob/master/CONTRIBUTING.md)
## Autores
Rafael
Tomaz Arlindo
Rai Guilherme
Paulo Mateus
Lucas Aires
---
## Licença
**GNU General Public License v3.0**
Este projeto está licenciado sob a GNU GPL-3.0. Abaixo, um resumo dos principais pontos:
**Liberdade de uso:** Você pode usar o software para qualquer finalidade.
**Distribuição:** É permitido distribuir cópias, desde que a licença seja mantida.
**Modificações:** Alterações no código são permitidas, mas as versões modificadas devem ser licenciadas sob os mesmos termos.
**Software Livre:** O código-fonte deve estar disponível em todas as distribuições do software.
**Garantias:** Não há garantias para o software.
Para mais detalhes, consulte o texto completo da licença [aqui](https://github.com/Tomaz-Arlindo/LibraryApi/blob/master/LICENSE).