{"id":20811318,"url":"https://github.com/express42/search_engine_ui","last_synced_at":"2025-06-17T18:38:19.249Z","repository":{"id":66323610,"uuid":"115001348","full_name":"express42/search_engine_ui","owner":"express42","description":null,"archived":false,"fork":false,"pushed_at":"2024-03-03T12:07:13.000Z","size":9,"stargazers_count":2,"open_issues_count":0,"forks_count":35,"subscribers_count":19,"default_branch":"master","last_synced_at":"2025-05-17T00:33:35.577Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/express42.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2017-12-21T12:02:33.000Z","updated_at":"2022-02-16T13:45:56.000Z","dependencies_parsed_at":"2025-05-07T09:45:16.484Z","dependency_job_id":null,"html_url":"https://github.com/express42/search_engine_ui","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/express42/search_engine_ui","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/express42%2Fsearch_engine_ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/express42%2Fsearch_engine_ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/express42%2Fsearch_engine_ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/express42%2Fsearch_engine_ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/express42","download_url":"https://codeload.github.com/express42/search_engine_ui/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/express42%2Fsearch_engine_ui/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260419756,"owners_count":23006344,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-17T20:40:08.548Z","updated_at":"2025-06-17T18:38:14.238Z","avatar_url":"https://github.com/express42.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Search Engine UI\n\nВеб-интерфейс поиска слов и фраз на проиндексированных [ботом](https://github.com/express42/search_engine_crawler) сайтах.\n\nВеб-интерфейс минимален, предоставляет пользователю строку для запроса и результаты. Поиск происходит только по индексированным сайтам. Результат содержит только те страницы, на которых были найдены все слова из запроса. Рядом с каждой записью результата отображается оценка полезности ссылки (чем больше, тем лучше).\n\n## Необходимые компоненты\nДля запуска веб-интерфейса нужно установить дополнительные компоненты python командой\n```\npip install -r requirements.txt\n```\n\nДля работы веб-интерфейса нужен запущенный сервис `mongodb`\n\n## Запуск веб-интерфейса\n### Переменные окружения\n* `MONGO` - адрес `mongodb`-хоста\n* `MONGO_PORT` - порт для подключения к `mongodb`-хосту\n\n### Пример для запуска\nВ общем случае веб-интерфейс можно запустить с помощью команд\n```\ncd ui\nFLASK_APP=ui.py gunicorn ui:app -b 0.0.0.0\n```\n\nДля проверки работы веб-интефейса надо зайти по адресу `http://HOST_IP:8000/`, где `HOST_IP` - адрес хоста на котором запущен веб-интерфейс.\n\n## Тестирование\n### Необходимые компоненты\nДля тестирования необходимо установить дополнительные компоненты с помщью команды\n```\npip install -r requirements.txt -r requirements-test.txt\n```\n\n### Тестирование\nБазовая команда для запуска unit-тестов\n```\npython -m unittest discover -s tests/\n```\n\nКоманды для генерации отчета о покрытии кода тестами\n```\ncoverage run -m unittest discover -s tests/\ncoverage report --include ui/ui.py\n```\n\n## Мониторинг\nМетрики для снятия `prometheus` доступны по адресу `http://HOST_IP:8000/metrics`, где `HOST_IP` - адрес хоста на котором запущен бот.\n\n### Метрики\n* `web_pages_served` - количество обработанных запросов\n* `web_page_gen_time` - время генерации веб-страниц, учитывая время обработки запроса\n\n## Логирование\nБот отправляет логи в `json`-формате в `stdout`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexpress42%2Fsearch_engine_ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fexpress42%2Fsearch_engine_ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexpress42%2Fsearch_engine_ui/lists"}