Backend do Grupo 03: Bazar

Neste repositório está a implementação do backend do projeto do grupo 03, que consiste em uma API RESTFull desenvolvida com Java e o ecossistema Spring.

Sumário

1. Sobre o projeto
   • Tecnologias utilizadas
2. Começando
   • Pré-requisitos
   • Instalação
3. Uso
4. Roadmap
5. Contribuindo
6. Contato
7. Agradecimentos

Sobre o projeto

Neste repositório será desenvolvida uma API RESTFull voltada para as necessidades de um Bazar que deseja expandir suas vendas migrando para as vendas on-lines.

(Voltar ao topo)

Tecnologias utilizadas

• Spring
  • Spring Boot
  • Spring Data JPA
  • Spring Security
• PostgreSQL
• pgAdmin 4
• H2 Database Engine
• IntelliJ IDEA
• Insomnia
• Heroku
• Vercel

(Voltar ao topo)

Começando

Abaixo estão as instruções para começar a contribuir com o projeto e a executa-lo localmente.

Pré Requisitos

Estes são os pré-requisitos necessários para executar este projeto:

• JDK 17

  java --version

  • Deve ser exibido algo assim na tela:

    java 17.0.1 2021-10-19 LTS
    Java(TM) SE Runtime Environment (build 17.0.1+12-LTS-39)
    Java HotSpot(TM) 64-Bit Server VM (build 17.0.1+12-LTS-39, mixed mode, sharing)
    

• IDE

  • Você pode qualquer IDE para contribuir e executar este projeto, mas é recomendado que seja utilizado o IntelliJ IDEA

Instalação

1. Clone o projeto

   git clone https://github.com/UnBArqDsw2022-1/2022.1_G3_Bazar_Backend.git

2. Abra o projeto na sua IDE ou editor e instale as dependências gerenciadas pelo Maven.

3. Se a sua IDE ou editor não baixar as dependências do projeto automaticamente, abra o terminal no diretório do projeto e execute:

   • Windows:

     .\mvnw spring-boot:run
     

   • Linux:

     ./mvnw spring-boot:run
     

(Voltar ao topo)

Uso

Abra o endereço local http://localhost:8080/ e qualquer outro recurso da API estará disponível a partir deste endereço.

Para mais exemplos veja a Documentação da API

(Voltar ao topo)

Roadmap

• Criação do projeto
• Feature 2
• Feature 3

Veja as issues abertas para uma lista completa das funcionalidades que estão e que já foram implementadas.

(Voltar ao topo)

Contribuindo

As contribuições são o que tornam a comunidade de código aberto um lugar incrível para aprender, inspirar e criar. Quaisquer contribuições que você fizer são muito apreciadas.

Se você tiver uma sugestão para melhorar isso, faça um fork do repositório e crie uma solicitação pull. Você também pode simplesmente abrir um problema com a tag "melhoria". Não se esqueça de dar uma estrela ao projeto! Obrigado novamente!

1. Fork do projeto
2. Crie a sua funcionalidade na branch (git checkout -b feature/AmazingFeature)
3. Commit suas mudanças (git commit -m 'Add some AmazingFeature')
4. Faça push para a branch (git push origin feature/AmazingFeature)
5. Abra um Pull Request

(Voltar ao topo)

License

(Voltar ao topo)

Contato

Link do projeto: https://github.com/UnBArqDsw2022-1/2022.1_G3_Bazar_Backend

(Voltar ao topo)

Agradecimentos

(Voltar ao topo)