/stock-manager

project made with Java to manage stock

Primary LanguageJava

Stock Manager

API feita em Java para gerenciamento de estoque.


Tecnologias   |    Como executar   |    Desenvolvimento   |    Plugins   |    Como contribuir   |    Contribuidores

Tecnologias

Tecnologias utilizadas no projeto:

São tecnologias de fácil acesso aos desenvolvedores que utilizamos para criar a nossa aplicação, sendo o repositório de versionamento o Github.

Como executar

Stock Manager requer Java na versão 11 para funcionar corretamente, assim com uma versão específica de MySQL e as denais tecnologias utilizadas.

Para simplificar o processo de execução usamos o Docker como forma facilitada de rodar a aplicação e embutir todas essas dependências.

Executando a aplicação:

docker-compose up --build

Desenvolvimento

Usamos o InteliJ no desenvolvimento, pois é a IDE que temos mais familiaridade, mas caso queira contribuir sinta-se livre para utilizar o que lhe for mais conveniente.

Caso o InteliJ não instale todos os pacotes de dependência assim que você abrir a aplicação ou estiver utilizando outra IDE use os comando abaixo.

$ mvn clean
$ mvn install

A instalação será útil apenas em tempo de desenvolvimento, pois como utilizamos o Docker caso queira executar o projeto basta rodar o comando de execução citado acima.

Plugins

  • Spring Boot

    • Definição da base do projeto.
  • Maven

    • Gerênciamento de dependências

Como contribuir

Não precisa criar uma issue, uma boa PR que traduza a funcionalidade será bem vinda.

  1. Dê um fork no projeto.
  2. Crie a sua branch.
$ git checkout -b <new-branch-name>
  1. Desenvolva o que desejar e salve suas alteradoes.
$ git commit -m "Type here a quick description of your feature"
  1. Atualize o projeto Esse passo é muito útil pois caso haja atualziações você poderá consertar os erros gerados
$ git pull origin master
  1. Envie sua alterações e seu pull request.
$ git push

Contribuidores

Lucas Polizeli   |    Victor Barreto   |    Kaique Vinicius


Icons made by Freepik from www.flaticon.com