Musicalizou é uma API REST que tem como principal objetivo promover a prática no desenvolvimento de aplicações com Java e Spring.
- Explorar músicas;
- Reviews das músicas;
- Gerenciar artistas;
- Login e controle de acesso;
- Histórico da base de dados (migrations).
- Spring Boot;
- Spring Security;
- Spring Data JPA;
- Spring Tests;
- Lombok;
- Validações;
- JWT (JSON Web Tokens);
- Hashing de senha com BCrypt;
- Migrations com Flyway;
- Swagger para documentação;
- Database exclusiva para testes - H2;
- Database exclusiva para produção - Mysql;
- Perfil de produção - application.properties
- Perfil de testes - application-test.properties
- Controllers
- Services
- Domain
- Infra
- Testes
- Migrations de produção - Mysql
-
Configuração do Ambiente:
- Certifique-se de ter o Java JDK, o MySQL e o Maven instalados em sua máquina.
- Caso não possua algum desses requisitos instalados, basta digitar
java --version
,mvn --version
oumysql --version
e verificar o comando de instalação no Linux. - Configuração do MySQL: MySQL
- Clone o repositório do Musicalizou para o seu ambiente local.
-
Configuração do Banco de Dados:
- Configure as credenciais do banco de dados no arquivo
application.properties
.
- Configure as credenciais do banco de dados no arquivo
-
Execução da API:
- Abra o projeto em sua IDE preferida.
- Execute o aplicativo Spring Boot.
-
Acesso à API:
- URL de acesso: http://localhost:8080/swagger-ui/index.html
-
Realizar Login:
- email: basicUser@gmail.com
- password: 123456
-
Copiar Token para autorização:
-
Requisições liberadas:
- Depois de inserir o token no campo de autorização, todas as requisições estarão liberadas.
- Desenvolvimento do Front-end: Embora a API REST do Musicalizou forneça acesso aos dados, uma interface de usuário (UI) pode ser desenvolvida e integrada para facilitar a interação com os recursos da API.
Se você deseja contribuir com o desenvolvimento do Musicalizou, siga estas etapas:
- Faça um fork do repositório e clone o fork para o seu ambiente local.
- Crie uma branch para sua nova funcionalidade ou correção de bug:
git checkout -b nome-da-sua-branch
. - Faça suas alterações e adicione testes, se aplicável.
- Commit suas alterações:
git commit -m 'Descrição das alterações'
. - Push para a branch:
git push origin nome-da-sua-branch
. - Abra um pull request no repositório original.
Sinta-se à vontade para contribuir com esta aplicação!
O Musicalizou é licenciado sob a MIT License.