search

lageIBUSP / notaR

Repositório para o código do notaR 4.0
2 stars 2 forks source link

readme

notaR

deploy-on-labtrop Um sistema para notas automatizadas em cursos que utilizam a linguagem R

O notaR é um sistema para correção automática de exercícios em linguagem R, armazenamento e visualização das notas resultantes. Ele é um software colaborativo, desenvolvido em linguagens de código aberto.

Se você for usar o notaR, cite como: Chalom, A., Salles, M., Prado, P. I. & Oliveira, A. Adalardo de (2012). notaR - Um sistema para notas automatizadas em cursos que utilizam a linguagem R (Version 2.0), from https://github.com/lageIBUSP/notaR.

Usando o notaR

O notaR é usado hoje em cursos oferecidos pela Universidade de São Paulo (USP), Universidade Estadual Paulista (UNESP), Instituto Nacional de Pesquisas da Amazônia (INPA), Universidade Federal do Rio Grande do Norte (UFRN), abaixo o link para o material de duas destas disciplinas:

Para acessar a plataforma online usada por estes cursos, clique aqui. Caso queira utilizar essa plataforma para um curso com os alunos cadastrados e com registros de nota, encaminhe email para Alexandre Adalardo de Oliveira.

Documentação

A documentação do sistema notaR está disponível em um sistema wiki. Clique aqui.

Instalando o notaR

O notaR 4.0 é instalado através do Docker. O Docker mantém cada parte do notaR isolada em um contêiner, separada do sistema operacional. Isso permite que o notaR funcione exatamente igual em qualquer sistema, mesmo que o sistema não tenha PHP, MySql ou R. Por isso, a única ferramente necessária para instalar o notaR é o próprio Docker. Instale o Docker no seu sistema antes de começar a instalação (instruções aqui).

Para instalar uma nova plataforma notaR, siga os seguintes passos (nota: alguns desses comando só funcionam em linux):

  1. Clone este repositório no seu servidor
  2. Crie o arquivo .env a partir do .env.example, com as informações do seu servidor. Use APP_ENV=local para desenvolvimento e APP_ENV=production para produção.
  3. Edite os valores de WWWUSER e WWWGROUP de acordo com o user id do seu usuário
  4. Rode o script deploy.sh
  5. Gere uma chave e registre ela no seu .env: 
    docker exec -t notar_app_1 php artisan key:generate
  6. Crie o novo banco de dados: 
    docker exec -t notar_app_1 php artisan migrate
  7. Crie um usuário admin com login admin@notar.br: 
    docker exec -t notar_app_1 php artisan migrate:admin novasenha

Atualizando o CSS e javascript

O CSS do notaR é gerado a partir dos arquivos .scss na pasta resources/sass. Os scripts javascript estão na pasta resources/js. Após modificar esses arquivos, é preciso compilar o código usando o npm. Em ambiente de desenvolvimento, use o script npm run dev, e antes de submeter qualquer commit, compile a versão de produção com npm run prod.

Rodando os testes de integração

ATENÇÃO: ESSES TESTES DESTROEM SEU BANCO DE DADOS LOCAL. NÃO RODE EM PRODUÇÃO

Os testes foram escritos para ajudar no desenvolvimento da plataforma. Todos os dados do banco de dados são destruídos antes dos testes, para evitar conflitos. Os testes foram desenvolvidos em Cypress usando o pacote de cypress para laravel laracasts/cypress. Alguns arquivos foram gerados automaticamente usando o comanto php artisan cypress:boilerplate.

Para testar e desenvolver a plataforma, instale o notaR no seu ambiente local para testes, seguindo o guia acima. Além disso, é necessário instalar o npm. Com isso, para abrir a interface gráfica do cypress, basta executar o seguinte comando:

npx cypress open

Na interface gráfica, selecione E2E Testing, e um browser à sua escolha.

Para rodar todos os testes de uma vez, direto do terminal, rode:

npx cypress run

Para mais detalhes, consulte a documentação do Cypress.

Debug e profile

O notaR está configurado com ferramentas de debug e profiling para ajudar no desenvolvimento. Para habilitar o Xdebug, abra o arquivo docker/php/php.ini, descomente a linha de xdebug.mode e construa novamente os containers. O debug pode ser feito na sua IDE (no VSCode, é recomendado instalar a extensão Xdebug) e os arquivos de profiling serão gerados na pasta storage/logs e podem ser lidos com o KCacheGrind.

Backup do banco de dados mysql no Docker

Para fazer o dump do banco de dados, primeiro entre no contêiner passando as variáveis de ambiente do .env:

docker exec -ti --env-file=.env notar_mysql_1 bash

E em seguida faça o dump usando as variáveis de ambiente:

mysqldump -uroot -p${DB_PASSWORD} ${DB_DATABASE} > bak.sql

Por fim, copie o arquivo de backup do contêiner para fora do contêiner:

docker cp notar_mysql_1:bak.sql .

Licença de uso

O código fonte do notaR está disponível sob licença GPLv3.