MirAn55500 / aaa-frontend-app

Веб приложение для распознавания текста в рамках Avito Analytics Academy

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

AAA Frontend Application

Описание

В этом репозитории находится шаблон для веб приложения для 3-го занятия курса "Frontend для DS-инженера" в Академии Аналитиков Авито.

Приложение позволяет загрузить изображение и распознать на нём текст.

В результате выполнения домашнего задания вы познакомитесь с:

  • вёрсткой HTML документа
  • CSS фреймворком Bootstrap
  • веб фреймворком aiohttp
  • шаблонизатором Jinja

Требования

Для работы сервиса вам нужен Docker.

Быстрый старт

  1. Сделайте форк этого репозитория
  2. Склонируйте форк к себе на компьютер
  3. Если у вас macOS или Linux, то выполняйте все команды из этого файла в терминале через make
  4. Если у вас Windows, то можно выполнять команды вручную, скопировав их из Makefile или использовать предложенные решения.
  5. Запустите сервер командой make dev
  6. Откройте в браузере страницу http://localhost:8080/
  7. Приложение должно работать - вы увидите инструкции что делать дальше
  8. После внесения ваших изменений, не забудьте прогнать тесты и линтеры- без них задание не будет принято
  9. Пришлите мне ссылку на ваш репозиторий с выполненным заданием

FYI

make это утилита, используемая в unix системах для запуска команд из файла Makefile.

Установка

Соберите образ для докера:

make build

Этот шаг будет выполняться автоматически при каждом запуске.

Запуск

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

make dev

Для запуска приложения в продакшн режиме:

make run

Тестирование

Для запуска тестов:

make test

Прохождение тестов является обязательными критерием приёмки домашнего задания.

Линтеры

Для запуска линтеров:

make lint

или каждый по отдельности:

make black
make flake8
make pycodestyle
make pylint

Black будет форматировать ваш код- это нормально. Линтеры так же будут запускаться через github actions при каждом пуше.

При нерабочих тестах и линтерах задание не будет принято.

Полезные ссылки

About

Веб приложение для распознавания текста в рамках Avito Analytics Academy

License:GNU General Public License v3.0


Languages

Language:Python 55.7%Language:HTML 26.8%Language:Makefile 14.1%Language:Dockerfile 3.4%