/mocs-maven

[WIP] MOCS port to Maven.

Primary LanguageJava

java 8 jdk maven persistence eclipselink jasperreports html5 css3 js jbcrypt mysql heroku

MOCS

Index

  1. Preview
  2. Sobre
  3. Ferramentas
  4. Níveis de Permissão
  5. Como usar o projeto
  6. To do
  7. Como contribuir
  8. Desenvolvedores

Preview

A versão mais recente deste projeto sempre estará disponível para testes em mocs.euaaron.codes.

Sobre

MOCS, ou Menu and Order Control System, como o próprio nome diz é um sistema para controlar pedidos e exibir cardápios.

O sistema permirá que usuários cadastrados pesquisem estabelecimentos e vejam os pratos disponíveis.

Todo usuário pode cadastrar um estabelecimento e vincular usuários à este estabelecimento como funcionários.

O usuário que cadastra um estabelecimento, automáticamente é adicionado à lista de funcionários, com o nível de permissão 0 (nível dado à funcionários com cargos administrativos máximo).

MOCS foi inicialmente desenvolvido para a disciplina de LPII (Linguagem de Programação 2) em 2019. Apesar do foco da disciplina ser o back-end, seu front-end foi inicialmente desenvolvido como trabalho da disciplina de Desenvolvimento Web. Essa versão de 2019 pode ser encontrada aqui.

Em 2020, durante a disciplina de LPIII (Linguagem de Programação 3) recriamos a estrutura do projeto adicionando o Maven, e a camada DAO, adicionando persistência com o eclipse link. Também alteramos os IDs numéricos para UUID e adicionamos criptografia na senha do usuário, além disso descartamos a utilização do Bootstrap 4.0 e demos uma reisada na lógica do sistema.

Revisar a lógica trouxe um significado à mais para o projeto, nos possibilitando entender de verdade o que nós queriamos fazer e como fazer. Com isso, nos livramos da classe Função, que nem estava sendo usada, e no lugar adicionamos aos funcionários o que chamamos hoje Nível de Permissão.

Ferramentas

Abaixo a lista das ferramentas utilizadas neste projeto:

  • Java JDK-8 (1.8)
  • Apache Tomcat 8.0.15
  • Netbeans 12.1
  • Visual Studio Code (para melhorar a produtividade ao desenvolver o front-end)
  • Figma.com (para prototipar as páginas)
  • Insomnia Core (para testar requisições do tipo GET e POST rapidamente)
  • as demais ferramentas e suas versões estão especificadas no arquivo pom.xml;

Níveis de Permissão

Nível 4 - Cheff

  • pode listar, adicionar, alterar e remover pratos;
  • pode listar comandas e pedidos;

Nível 3 - Garçom

  • pode listar, adicionar e remover comandas;
  • pode listar, adicionar e remover pedidos de comandas;

Nível 2 - Supervisor

  • todas as permissões do nível 3;
  • pode alterar pratos;
  • pode alterar comandas;
  • pode alterar pedidos de comandas;

Nível 1 - Gerente Geral

  • todas as permissões anteriores;
  • pode adicionar, alterar ou remover funcionários (exceto com nível 0);

Nível 0 - Administrador

  • todas as permissões anteriores;
  • pode adicionar funcionários com nível de permissão 0;
  • pode alterar e deletar o estabelecimentos do sistema.

Como usar o projeto?

  1. Clone o projeto como preferir, por exemplo:
git clone https://github.com/euaaron/mocs-maven.git

  1. Abra o projeto em sua IDE java preferida, recomendo o Netbeans 12.1 por não precisar de muitas configurações iniciais.

  2. Tenha o Tomcat instaldo, o programa não funciona com o Glassfish.

Se tiver dificuldades para instalar o Tomcat, instale-o através do Netbeans 8 e copie as configurações escritas em tools->servers->Tomcat. Atenção: Esta ação é requerida pois o programa não vai abrir no Netbeans 8.

  1. Instale as dependências:
  • pelo Netbeans, clique botão direito no projeto e Resolve project problems;
  • ou pelo maven no terminal, digite mvn install ou mvnw install.
  1. Construa o executável do projeto (ex.: mocs-1.0.0.war)
  • basta clicar em build no Netbeans;
  • ou pelo maven no terminal, digite mvn package ou mvnw package.
  1. Executar
  • no netbenas basta clicar em run ou debug;
  • ou no terminal (com o maven), na pasta raiz do projeto digite:
java $JAVA_OPTS -jar target/dependency/webapp-runner.jar --port 80 target/*.war

To Do

Como contribuir?

  • Para dúvidas ou sugestões, deixe um issue.
  • Quer codar com a gente? Faça um fork, adicione seu código. - Ah! Pelo menos no momento do merge, faça um commit semântico e comente quais melhorias que você adicionou.

Este é um projeto acadêmico, não tenha medo de falhar ou de não saber. Colabore para treinar e evoluir com seus erros!

Desenvolvedores