4YouSee Webhook

⚈ Sobre este Projeto

Aplicação web desenvolvida em framework Django usando linguagem de programação Python. Nele é possível é possível adicionar várias contas para que dessa forma seja possível obter os dados delas num lugar só. Desta forma fica centralizado o gerenciamento e monitoramento de várias contas.

Você pode acessar na conta a partir dessa rota https://webhook-4uc.herokuapp.com. Pode solicitar o usuário e senha ao e-mail suporte@4yousee.com.br o seguir os seguintes passos para rodar o projeto no seu computador.

⚈ Requisitos

Pip, Python instalados e configurados como variáveis de ambiente.

1. Criar uma pasta e dentro dela execute os seguintes comandos:

• Para isolar o ambiente:

  python -m venv .venv
  

• Para ativar o ambiente isolado:

  Windows	Linux
  \Scripts\activate.bat	source .venv/bin/activate

• Instalando as dependencias:

  pip install -r requirements.txt
  

2. Criar arquivo .env na raiz, com as seguintes variáveis:

   DEBUG = True

   SECRET_KEY =

   Para preencher as seguintes variáveis você pode usar sua conta de gmail (por exemplo) ou usar outros proveedores como mailgun, mailchimp, sendgrid, etc.

   EMAIL_USE_TLS = True

   EMAIL_HOST =

   EMAIL_PORT = 587

   EMAIL_HOST_USER =

   EMAIL_HOST_PASSWORD =

   EMAIL_BACKEND = django.core.mail.backends.smtp.EmailBackend

   Como gerar o SECRET_KEY ?

   Para gerar o SECRET_KEY, crie primeiramente o arquivo .env e adicione todas as variáveis anteriormente mencionadas com valores vazíos. Enseguida, execute python manage.py shell e digite o seguinte:

   >>> from django.core.management.utils import get_random_secret_key
   >>> get_random_secret_key()
   908ads768/*>-06&6a # Esse é valor que deve ser colocado no .env na variável SECRET_KEY
   

3. Configurar um banco de dados.

   Você precisa ter um banco de dados para rodar o projeto. Deve adicionar a variável DATABASE_URL no arquivo .env criado no passo anterior e colocar nele a endereçõ no formato URI, como é mostrado no seguinte exemplo:

   DATABASE_URL = mysql://username:password@host:100/nome_do_banco
   

4. Instalação do Projeto no Banco de dados.

   Todo projeto django possui seus arquivos prontos para se adaptar a um banco de dados, e por isso para instalar o projeto num banco de dados, é necessário migrar os dados para o banco com o seguinte comando desde o terminal

   python manage.py migrate
   

5. Criando super usuário.

   O super usuário é necessário porque o projeto precisa de um usuário que consiga ter todas as permissões. A primeira funcionalidade do super user é criar outros usuários. Para criar ele basta executar a seguinte na linha de comando:

   python manage.py createsuperuser
   

---

⚈ Executando o Projeto

Para rodar o projeto basta com executar a seguinte linha no terminal, lembrando ter o ambiente isolado ativo.

python manage.py runserver

---

⚈ Features

Paths

O projeto possui os seguintes caminhos:

• / : (home)
• /conta/ : (conta_detalhe)
• /relatorio/ :(solicitar_relatorio)
• /playlogs/ :(playlogs)

Home

Tela principal que exibe as contas adicionadas a partir da URL e token.

Detalhe de uma Conta

Tela que apresenta as informações de players, categorias, contas, playlists e playlogs de uma conta em específico.

Solicitar Relatório

Tela para solicitar relatórios de uma conta em específico. Considera todos os playlogs do día desde 00:00:00 até 23:59:59

Playlogs

Tela que exibe todos os playlogs existentes na aplicação separados por conta, e por día. Além esse path serve de webhook para receber a resposta da api do manager ao momento de solicitar um report.