Helpmydoc - README versão PT-BR

helpmydoc.net

Sumário

1. Descrição/Resumo
2. Pré-requisitos
3. Rodando o projeto/Instalação
4. Conhecimento adquirido no projeto
5. Licença

---

1. Descrição / Resumo

O website tem como uma de suas funções explorar a pasta /tmp/ que estão disponiveis na maioria da distros linux, de maneira que, ao usuario enviar um arquivo, o servidor consiga baixar e em seguida ja converter o arquivo guardando-o no sistema por um periodo curto de tempo até que ele seja deletado.

Foi pensado também na simplicidade com que o usuario poderia enviar os arquivos, e principalmente tornando o site open-source para que todos possam colaborar.

A pasta /tmp/ é configurada na máquina de modo que de 30 em 30 minutos o sistema reboota e os arquivos presentes nela são deletados, portanto isso é a garantia ded que os arquivos não ficam salvos.

2. Pré-requisitos

3. Instalação

#Ambiente linux

#instalando vitualenv
$ python3 -m venv <nome_da_venv_aqui>

#clonando o repositorio
$ git clone https://github.com/joaoguilherme1/convert-files

#instalando os arquivos do projeto
pip install -r /caminho/para/requirements.txt

Para subir o repositório no github foi necessario esconder algumas chaves do projeto. então sera necessario criar um arquivo chamado credenciais.py no caminho /tudoparapdf/tudoparapdf/credenciais.py com o conteudo :

#conteudo do arquivo

chave = SUA_CHAVE_DJANGO
hosts = []
status = True

4. Conhecimento adquirido no projeto

Ferramentas usadas nesse projeto:

• Python
  • Django
• Javascript
• HTML
• CSS
  • Bootstrap
• AWS
  • EC2
    • Ubuntu
  • Route 53
  • CloudWatch
• uWSGI
• Nginx

5. Licença

MIT License - Veja o arquivo LICENSE.md