fullstack fastapi vuejs price aggregator

Agregador de preços Fullstack

Agregador de preços de supermercados do Reino Unido por meio de web scraping. Isso foi desenvolvido para meu projeto universitário como MVP, portanto há aspectos que não funcionam corretamente. Posso atualizá-lo no futuro.

Características

• Back-end Python REST via FastAPI
• VueJS Frontend SPA com TypeScript usando este modelo.
• Autenticação JWT entre backend e frontend
• CLI
• Docker
• Poesia
• Preços raspados na Web via selectorlib
• Raspe páginas habilitadas para JavaScript usando splash

Configurar

Certifique-se de ter o Docker e o Node.js instalados.

1. Clonar este repositório
2. cd na raiz do projeto e execute docker-compose up --build -d . O backend inicia e na primeira execução construirá todos os contêineres necessários, o que pode levar alguns minutos.
3. Assim que o back-end terminar de ser construído, obtenha um shell com docker-compose exec backend bash .
4. Para inicializar o banco de dados, execute python manage.py createdb de dentro do shell bash.
   • (Opcional) Para propagar o banco de dados com dados fictícios, execute python manage.py seeddb Observe que todas as senhas estão definidas como password
5. cd no diretório do cliente, execute npm install que instalará os módulos de nó necessários.
6. execute npm run serve que atenderá o frontend do cliente.

URLs do projeto

URL	Descrição
0.0.0.0:8000/api	API JSON de back-end
0.0.0.0:8000/docs	Documentação de referência de API gerada por OpenAPI/Swagger de back-end
0.0.0.0:8000/redoc	Documentação interativa alternativa fornecida pela ReDoc
host local:9527	Aplicativo Frontend VueJS de página única

CLI

O back-end inclui uma CLI fortemente inspirada no Dispatch da Netflix.

typer (mesmo autor do FastAPI) foi usado para criar uma CLI para o projeto e é acessado via manage.py.

Para executar comandos, você precisará de um shell rodando dentro do contêiner de back-end com:

 docker-compose run backend bash

Para ver todos os comandos disponíveis:

 root@72293bee6b37:/app# python manage.py 
Usage: manage.py [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  config      Display application configuration.
  createdb    Creates an empty database.
  createrole  Add role to database.
  createuser  Create new user in the database.
  develop     Start a development server with reload.
  dropdb      Drop the existing database.
  routes      Display application routes and dependencies.
  seeddb      Add fake data to database.
  shell       Starts an interactive shell with app object imported.

Rotas

 root@72293bee6b37:/app# python manage.py routes

Application Endpoints
Path                           Methods    Dependencies
-----------------------------  ---------  --------------------------------------------------------
/api/v1/users/                 GET        ['RoleChecker: Roles: admin,user']
/api/v1/users/                 POST       ['RoleChecker: Roles: admin,user']
/api/v1/users/{id}             GET        ['RoleChecker: Roles: admin,user']
/api/v1/users/{id}             PUT        ['RoleChecker: Roles: admin,user']
/api/v1/users/{id}             DELETE     ['RoleChecker: Roles: admin,user']
/api/v1/users/{id}/roles       GET        ['RoleChecker: Roles: admin,user']
/api/v1/users/{id}/roles       PUT        ['RoleChecker: Roles: admin,user']
/api/v1/users/{id}/shops       GET        ['RoleChecker: Roles: admin,user']
/api/v1/users/{id}/shops       PUT        ['RoleChecker: Roles: admin,user']
/api/v1/roles/                 GET        ['RoleChecker: Roles: admin,user']
/api/v1/roles/                 POST       ['RoleChecker: Roles: admin,user']
/api/v1/roles/{id}             GET        ['RoleChecker: Roles: admin,user']
/api/v1/roles/{id}             PUT        ['RoleChecker: Roles: admin,user']
/api/v1/roles/{id}             DELETE     ['RoleChecker: Roles: admin,user']
/api/v1/shops/                 GET        ['RoleChecker: Roles: admin,user']
/api/v1/shops/                 POST       ['RoleChecker: Roles: admin,user']
/api/v1/shops/{id}             PUT        ['RoleChecker: Roles: admin,user']
/api/v1/shops/{id}             DELETE     ['RoleChecker: Roles: admin,user']
/api/v1/shops/listings/        GET        ['RoleChecker: Roles: admin,user']
/api/healthcheck               GET        []

Configuração

 python manage.py config

Application Configuration
Setting                     Value(s)
--------------------------  --------------------------------------------------------------------
APP_DIR                     /app/app
STATIC_DIR                  /app/app/static
EMAIL_TEMPLATES_DIR         /app/app/static/email-templates/html
PROJECT_NAME                Fastapi Backend
SERVER_HOST                 0.0.0.0
CORS_WHITELIST              ['http://localhost', 'http://localhost:8000', 'http://0.0.0.0:8000']
FASTAPI_ENV                 development
DEBUG                       False
LOG_LEVEL                   debug
FIRST_SUPERUSER             [email protected]
FIRST_SUPERUSER_PASSWORD    a5dbf43e07f4d19e5b73bc89a8f74
USERS_OPEN_REGISTRATION     True
SECRET_KEY                  **********
JWT_AUTH_LIFETIME_SECONDS   604800
JWT_EMAIL_LIFETIME_SECONDS  3600
SMTP_USER                   [email protected]
SMTP_PASSWORD               **********
SMTP_TLS                    False
SMTP_SSL                    False
SMTP_HOST                   mailhog
SMTP_PORT                   1025
POSTGRES_USER               postgres
POSTGRES_PASSWORD           **********
POSTGRES_HOST               postgres
POSTGRES_PORT               5432
POSTGRES_DB                 fastapi_backend

Visualizações de front-end

Visualização de login

Visualização do painel de administração

Visualização CRUD do usuário

Visualização de criação de usuário

Visualização do perfil do usuário

Visualização CRUD da loja

Visualização selecionada da loja

Visualização de listagens raspadas