laplima/accontrol

ACControl – Controle de Atividades Complementares (PUCPR)

Versão containerizada

Instruções de uso

Configuração inicial (primeira execução)

• Baixe e descompacte o arquivo AC.zip.

• O diretório AC criado contém os seguintes arquivos e diretórios:

  • db: contém o "banco de dados" em JSON com as informações sobre cursos, categorias de atividades, metas, lista das atividades, lista de estu**s* e todos os lançamentos de atividades feitas. Estes arquivos podem ser editados "manualmente" com um editor de texto simples, desde que tomando o cuidado de manter a estrutura JSON. Neste diretório também se encontra o arquivo CSS para formatação dos relatórios gerados.
  • reports: contém os relatórios gerados pelo programa (em HTML e PDF);
  • archive: contém arquivo morto (estu***s transferidos do banco de dados)
  • accontrol.sh: scripts de criação do container e execução do programa accontrol.

• Certifique-se de que o motor do Docker ("docker engine – executado em conjunto com o Docker Dekstop) está rodando (instale https://www.docker.com/products/docker-desktop/, se necessário).

Executando o ACControl

• Certifique-se de abrir um terminal no diretório AC e digite:

bash
./accontrol.sh

• Quando o comando acima é executado pela primeira vez, o programa é baixado antes de ser executado.

• Os dados são armazenados no diretório db. Certifique-se de fazer backups periódicos desse diretório.

Dicas

• Use a tecla TAB para completar os comandos e os nomes dos estu***s.

  • inserir Fula<TAB> → inserir Fulano de Tal

• Digite parte do texto para buscar na lista de estu***s ou de atividades.

  • listar estudantes ma: lista todos os estu***s contendo "ma" (como "Maria", "Damasceno", etc.)

• Os comandos inserir, relatório, arquivar e salvar são sensíveis a contexto (i.e., utilizam referências de comandos executados anteriormente).

• O comando arquivar permite transferir estu***s e seus registros do banco de dados para um banco de dados especial chamado "archive". Exemplo:

  • arquivar Fulano de Tal: transfere Fulano de Tal para arquivo morto (archive)

• Para abrir este banco de dados, utilize:

  bash
  accontrol archive
  

• É possível editar diretamente os arquivos .json com um editor de texto simples para fazer pequenas correções ou excluir entradas ou mesmo estu***s.