fullstack fastapi vuejs price aggregator Скачать - fullstack fastapi vuejs price aggregator Скачать исходный код

fullstack fastapi vuejs price aggregator

Другие категории

1.0.0

Скачать

Полнофункциональный агрегатор цен

Агрегатор цен супермаркетов Великобритании с помощью веб-скрапинга. Он был разработан для моего университетского проекта в качестве MVP, поэтому некоторые аспекты работают неправильно. Возможно, я обновлю его в будущем.

Функции

Серверная часть Python REST через FastAPI
VueJS Frontend SPA с TypeScript с использованием этого шаблона.
JWT-аутентификация между серверной и внешней частью
интерфейс командной строки
Докер
Поэзия
Цены, очищенные из Интернета через selectorlib
Очистка страниц с поддержкой JavaScript с помощью Splash

Настраивать

Убедитесь, что у вас установлены Docker и Node.js.

Клонировать этот репозиторий
перейдите в корень проекта и запустите docker-compose up --build -d . Запускается серверная часть, и при первом запуске будут созданы все необходимые контейнеры, что может занять несколько минут.
После завершения сборки бэкэнда получите оболочку с помощью docker-compose exec backend bash .
Чтобы инициализировать базу данных, запустите python manage.py createdb из оболочки bash.
- (Необязательно) Чтобы заполнить базу данных фиктивными данными, запустите python manage.py seeddb Обратите внимание, что все пароли установлены на пароль.
cd в каталог клиента запустите npm install , который установит необходимые модули узла.
запустите npm run serve , который будет обслуживать клиентский интерфейс.

URL-адреса проекта

URL-адрес	Описание
0.0.0.0:8000/апи	Серверный API JSON
0.0.0.0:8000/документы	Справочная документация по API серверной части OpenAPI/Swagger
0.0.0.0:8000/редок	Альтернативная интерактивная документация, предоставленная ReDoc.
локальный хост: 9527	Одностраничное приложение Frontend VueJS

интерфейс командной строки

Бэкэнд включает в себя интерфейс командной строки, который во многом вдохновлен Dispatch от Netflix.

typer (тот же автор, что и FastAPI) использовался для создания CLI для проекта, доступ к нему осуществляется через Manage.py.

Для запуска команд вам понадобится оболочка, работающая внутри внутреннего контейнера, с:

 docker-compose run backend bash

Чтобы просмотреть все доступные команды:

 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.

Маршруты

 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        []

Конфигурация

 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