README.md

Projeto

Observações:

Postgres:

- Caso use Windows, pode ser que tenha uma instância do Postgres rodando na porta 5432 e poderá ocorrer conflito com postgres rodando no container
- Executar os seguintes comandos no terminal do Windows como administrador:
> netstat -ano | findstr 5432
> taskkill /f /pid _PID_

Insomnia:

- No repositório tem um arquivo insomnia_paneas.yaml, onde é possível importar todos os endpoints e serem executados com o insomnia.
- O token de acesso é atualizado automaticamente em todos os headers, mas o novo gerado pelo refresh token não, este deve ser inserido manualmente caso seja testado.

Banco de dados:

- Para facilitar, o banco de dados já será populado com algumas informações.
- Existem dois usuários cadastrados: **admin@mail.com** e **user@mail.com**
- A senha de ambos os usuários é: **123456**
- O usuário ADMIN pode acessar todos os endpoints e o USER apenas o metodo **GET** do endpoint /users
- Para acessar o banco de dados por meio do Beekeeper, por exemplo, utilizar as seguintes credenciais:
Host: localhost
Port: 5432
User: admin
Password: paneas
Default DB: main

Envio de emails:

- O email é enviado assim que o usuário é criado através da API.
- Para enviar emails é necessário resgatar uma chave, isso pode ser feito através do gmail.
- Procedimentos: Acessar gmail > Clicar na foto de perfil > Gerenciar sua Conta do Google > Segurança > Verificação em duas etapas > Senhas de app (no final da página)
- Após pegar essa chave de acesso, inserir no .env **(Isso deve ser realizado antes do BUILD!)**

Documentação:

- A documentação da API pode ser acessada através do endereço http://localhost:8000/docs
- A documentação é gerada com Swagger UI

Principais documentações como referência:

- https://fastapi.tiangolo.com/tutorial/
- https://alembic.sqlalchemy.org/en/latest/tutorial.html
- https://docs.python.org/2/library/email-examples.html#id5
- https://docs.docker.com/
- https://docs.celeryq.dev/

Inicializando o projeto:

- Clone o repositório: git clone git@github.com:rafaself/python-fastapi-user-management.git
- Pode ser necessário autenticação por ssh (https://docs.github.com/pt/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)
- Execute o comando:
> docker build -t paneas .
- Após finalizar o build, execute o seguinte comando:
> docker compose up
- Interagir com a aplicação por meio de ferramentas como Insomnia/Postman, Beekeeper (credenciais de acesso fornecidas acima), etc.