README

Este é um projeto open source, livre de restrinções e regido por uma licencá MIT.

Nota: Não possuimos responsabilidade de suporte ou reparação de qualquer natureza em razão de uso indevido ou inadequado de qualqeur natureza.

Está biblioteca segue os padrões descritos na PSR-2, logo, isso implica que a mesma está em conformidade com a PSR-1.

As palavras-chave "DEVE", "NÃO DEVE", "REQUER", "DEVERIA", "NÃO DEVERIA", "PODERIA", "NÃO PODERIA", "RECOMENDÁVEL", "PODE", e "OPCIONAL" neste documento devem ser interpretadas como descritas no RFC 2119. Tradução livre RFC 2119 pt-br.

1. Referências
2. Funcionalidades
3. Proposta do projeto
4. Instalação
   1. Download via Github
   2. Via Composer
5. Configuração final
6. Licença

1 - Referências

• PSR-1
• PSR-2
• RFC 2119. Tradução livre RFC 2119 pt-br

2 - Funcionalidades

• Autenticação de usuário
• Recuperação de senha por email
• Gerenciamento de arquivos (upload, download, exclusão e página com detalhes do arquivo)
• Organização de arquivos (sistema de tags)
• Dashboard (total de arquivos, total de tags, total de usuários...)
• Painel de preferências de sistema (com acesso restrito ao user master)

3 - Proposta do projeto

Este projeto foi desenvolvido para auxiliar professores, tutores e demais pessoas a centralizarem o recebimento de arquivos, para isso basta criar uma tag (equivale a uma categoria ou assunto) e passar para os envolvidos, estes utilizarão a tag em questão para fazer upload direcionados de arquivo.

4 - Instalação

Segue abaixo as formas como você pode proceder para instalar este projeto.

4.1 - Download via Github

Após o download dos fontes. Acesse o diretório descarregado e execute o comando abaixo para descarregar as dependências:

composer install

Caso ainda não tenha o composer instalado, obtenha este em: https://getcomposer.org/download/

Para criar o arquivo de configuração e posteriormente gera uma chave:

cp .env.example .env
php artisan key:generate

4.2 - Via Composer

Para criar um projeto execute:

composer create-project --prefer-dist fabiojaniolima/webupload

caso seu ambiente seja produtivo, opcionalmente você pode fazer uma listanação limpa, ou seja, sem pacotes para ambiente de desenvolvimento:

composer create-project --prefer-dist fabiojaniolima/webupload --no-dev

5 - Configuração final

Inicialmente você deve informar os dados de acesso ao banco no arquivo .env presente na raiz do projeto.

Posteriormente a configuração do banco de dados você deve executar o comando abaixo dentro do diretório do projeto:

php artisan migrate

Pronto, agora abra o navegador e acessa sua aplicação.

6 - Licença MIT

Para maiores informações, leia o arquivo de licença disponibilizado com este projeto.