gabrielcoruja/java-spring-ecommerce-api

SpringMarket: API de E-Commerce com Spring Boot

Descrição

O SpringMarket é uma API de comércio eletrônico construída com Spring Boot Web, Spring JPA para persistência de dados e Spring Security com tokens JWT para Autenticação e Autorização. Desenvolvido para oferecer funcionalidades básicas de login e compra de produtos.

Funcionalidades (Em construção 🚧)

Usuários

• Cadastro de novos usuários.
• Login de usuários.

Tecnologias e Ferramentas Utilizadas

Tecnologias

• Java Versão 17
• Spring Boot
  • Spring Data JPA
  • Spring Security (Utilizado com JWT)
• Docker
  • Docker Compose
• PostgresSQL (Baixado via Docker)
• H2 database

Ferramentas

• IntelliJ IDEA
• Insomnia

Qualidade de código

O Checkstyle é uma ferramenta de análise estática de código que ajuda a garantir que o código-fonte Java siga um conjunto predefinido de regras de codificação. No projeto, é utilizado o arquivo de configuração intellij-java-google-style.xml do Google, que define um conjunto de diretrizes de codificação baseadas nas práticas recomendadas do Google para Java.

Para executar a análise, utilize o comando:

mvn checkstyle:check

Como Executar o projeto

Pré-requisitos:

• SDKMAN! (Software Development Kit Manager)
  • Ótima alternativa para baixar o Java e ter o controle de versões.
  • Versão utilizada foi a 17.x.x Oracle.
• Java Versão 17
• Docker

Instalação e Execução (Em construção 🚧)

1. Clone o repositório

   git clone [email protected]:GabrielCoruja/java-spring-ecommerce-api.git

2. Instalação e compilação dos recursos necessários

   mvn install -DskipTests

3. Iniciar o banco de dados e a aplicação

Start da aplicação com Docker

• Para subir a aplicação e o banco de dados, execute o comando:

  docker-compose up -d --build

Obs: Utilizando o docker os dados serão persistidos utilizando o PostgreSQL.

4. O projeto terá como base o endpoint http://localhost:8080

Testes (Em construção 🚧)

Para executar os testes, Utilize o comando:

Documentação (Em construção 🚧)