É um sistema de controle e auxílio à criação de TCCs pelos estudantes. Irá auxiliar também os orientadores, na correção e troca de informações com seus orientados.
Esta ferramenta permite que os estudantes acessem via Moodle (LTI) esta ferramenta, e desenvolvam o TCC importando o material previamente produzidos por eles mesmos, em atividades de "texto online".
O texto será formatado no padrão ABNT, inclusive as referências, que serão cadastradas na própria ferramenta de TCC.
Esta aplicação depende da instalação de algumas dependências externas para seu completo funcionamento.
Os pacotes do "phantomjs" são necessários para a instalação do Capybara, que é utilizado para rodar os testes de interface.
Para geração correta do TCC em PDF é necessário instalar uma distribuição do LaTex juntamente com o Abntex2. A instalação do LaTex é diferente no Ubuntu e no Mac OS X.
Em breve será disponibilizada instalação automatizada via Chef utilizando a instalação local, por intermédio do chef-solo.
Esta automação servirá tanto para o servidor quanto para a máquina de desenvolvimento e testes.
sudo apt-get install -y phantomjs imagemagick libmagickwand-dev graphviz redis-server
No Ubuntu vamos utilizar a distribuição Tex Live
wget http://mirror.ctan.org/systems/texlive/tlnet/install-tl-unx.tar.gz
tar zxvf install-tl-unx.tar.gz
# O nome da pasta vai depender da data em que for baixado, o final segue o formato aaammdd
cd install-tl-2*
./install-tl
Após a instalação é necessário incluir o TexLive no PATH (~/.bashrc ou ~/.zshrc):
PATH=/usr/local/texlive/2014/bin/x86_64-linux:$PATH
Para que o PATH também seja incluído pro "sudo", edite o arquivo "/etc/sudoers":
# Mudar esta linha:
Defaults secure_path="/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
# Para:
Defaults secure_path="/usr/local/texlive/2013/bin/x86_64-linux:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
Baixar e instalar a distribuição MacTex:
Download MacTex.pkg [ 2.3G - 30 May 2013 ]
Instalar o Graphviz (opcional): brew install graphviz
A instalação é feita pelo próprio gerenciador de pacotes do LaTex (tlmgr):
sudo tlmgr update --self
sudo tlmgr install abntex2 selnolig
sudo texhash
Para concluir é preciso alterar uma variavel de configuração do texmf.cnf:
sudo vim /usr/local/texlive/2013/texmf-dist/web2c/texmf.cnf
# Procurar pelo trexo abaixo: (próximo da linha 598)
openout_any = p
# trocar para:
openout_any = a
Criar arquivos yml baseados nos arquivos:
- database.yml.example
- email.yml.example
- errbit.yml.example
- moodle.yml.example
- newrelic.yml.example
- tcc_config.yml.example (Verifique o endereço da sua instalação do Moodle na variavel moodle_url)
Instalar gems e executar a migração do banco:
bundle install
rake db:migrate
Para rodar testes, utilize o comando a seguir, definindo opcionalmente a variavel de ambiente COVERAGE:
COVERAGE=true rake spec
Quando definido COVERAGE=true, será analizado também cobertura de testes da aplicação.
Esta aplicação usa Rails 4.1 e para tornar o desenvolvimento mais rápido, realiza o pré-load da aplicação usando Spring.
O Spring, apesar de facilitar o desenvolvimento diminuindo o tempo de carregamento da aplicação, pode gerar conflitos quando mudanças mais profundas (initializers, mudanças de configuração e gems) forem executadas, necessitando ser reiniciado.
Se alguma mudança não refletir no momento de desenvolvimento, basta desligar o mesmo e reiniciar a aplicação:
spring stop
Este projeto utiliza o editor CKEditor disponibilizado pela gem galetahub/ckeditor que realiza diversos procedimentos para facilitar a implantação do mesmo em um projeto Rails.
Nós utilizamos dois plugins adicionais aos que são disponibilizados por padrão pelo CKEditor:
- Auto Grow: responsável por aumentar dinamicamente a altura do editor de texto
- Citação: plugin próprio para disponibilizar marcação de citação
O padrão LTI é gerenciado pela IMS Global, que fornece uma ferramenta para auxiliar a validação da implementação: http://validator.imsglobal.org/
A implementação de LTI utilizada e disponibilizada pela "Instructureit" possui alguns caveats:
- A URL no Moodle deve vir com uma / no final, pois o Rails inclui essa barra independente dela existir ou não na URL original, e caso isso não seja seguido, teremos uma assinatura inválida
Contribuições
Bruno Martinenghi Sidronio de Freitas ([email protected] )
Bruno Saibro Silveira ([email protected])
Fábio César Ariati ([email protected])
Jorge Almeida Bastos Júnior ([email protected])
Luiz Henrique Américo Salazar ([email protected])
Osmar Floriano Guimarães de Oliveira ([email protected])
Wagner Daufenbach do Amaral ([email protected])
Autores
Universidade Aberta do SUS
Roberto Silvino ([email protected])
Gabriel Mazetto ([email protected])
Este projeto utiliza a licença MIT-LICENSE.