Skip to content

grintex/sauron

Repository files navigation


Web Feedback

Web Feedback é um sistema cujo principal objetivo é estreitar a comunicação entre a comunidade da UFFS e o programa Practice. Esse estreitamento possibilitará que ideias e demandas voltadas para o âmbito da melhoria da educação possam ser publicadas, discutidas, discorridas e desenvolvidas. O Web Feedback irá funcionar como um mural onde qualquer pessoa da comunidade UFFS poderá expor suas ideias, comentários, solicitar serviços, etc, no formato de post. A partir desse feedback o Practice terá facilidade em direcionar o fluxo de desenvolvimento e priorizar projetos.

Features

Aqui você pode colocar uma screenshot do produto resultante desse projeto. Descreva também suas features usando uma lista:

  • Fácil integração;
  • Poucas dependências;
  • Utiliza um template lindo para organizar o README;
  • Possui ótima documentação e testes.

Começando

1. Dependências

Para executar o projeto, inicialmente será preciso instalar as seguintes dependências:

2. Configuração

Feito a instalação das dependências, é necessário obter uma cópia do projeto, para isso faça o fork dele através do botão situado no canto superior direito e depois clone-o em sua máquima. Em seguida será preciso configurar a interação entre o projeto e suas dependências.

Banco de Dados

O SGBD utilizado no projeto é o MySQL sabendo disso acesse seu gerenciador e crie sua base de dados executando o seguinte comando:

CREATE DATABASE <nome-do-banco>

PHP

Instale as dependências do PHP usando o comando abaixo:

composer install

Pacotes

Instale os pacotes php necessários para rodar o projeto:

sudo apt install php-cli
sudo apt install php-mbstring
sudo apt install php-zip
sudo apt install php-xml
sudo apt install php-mysql
sudo apt install php-curl

Node

Instale também as dependências do NodeJS executando:

npm install

Laravel

Crie o arquivo .env a partir do arquivo .env.example gerado automaticamente pelo Laravel:

cp .env.example .env

Após isso, no arquivo .env altere o valor do campo DB_DATABASE para <nome-do-banco> criado anteriormente e substitua também o valor dos campos DB_USERNAME e DB_PASSWORD para seu usuário e senha do banco de dados, respectivamente.

Feita as alterações no .env execute o seguinte comando para a criação dos esquemas:

php artisan migrate

Por fim execute o comando abaixo para a geração da chave de autenticação da aplicação:

php artisan key:generate

Rodando o projeto

Finalmente, após seguido os passos anteriores, gere os recursos JavaScript e CSS:

npm run dev

e por fim inicie o servidor do Laravel:

php artisan serve

Após isso a aplicação estará rodando na porta 8000 e poderá ser acessada em localhost:8000.

Contribua

Sua ajuda é muito bem-vinda, independente da forma! Confira o arquivo CONTRIBUTING.md para conhecer todas as formas de contribuir com o projeto. Por exemplo, sugerir uma nova funcionalidade, reportar um problema/bug, enviar um pull request, ou simplemente utilizar o projeto e comentar sua experiência.

Veja o arquivo ROADMAP.md para ter uma ideia de como o projeto deve evoluir.

Licença

Esse projeto é licenciado nos termos da licença open-source Apache 2.0 e está disponível de graça.

Changelog

Veja todas as alterações desse projeto no arquivo CHANGELOG.md.

Projetos semelhates

Abaixo está uma lista de links interessantes e projetos similares:

About

Analytics tool to provide insights on the workload of academic personnel

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published