diff --git a/README.md b/README.md index 16232da..8a6bbaf 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,39 @@ # pred-city-env ->Проект "Прогнозирование негативных аспектов развития городской среды" на БММ 2023. ---- +[![GitHub](https://img.shields.io/github/license/dsuhoi/pred-city-env)](https://github.com/dsuhoi/pred-city-env/blob/main/LICENSE) +>Сервис по прогнозированию негативных аспектов развития городской среды. + -## Цели -... +--- +## Идея +Сервис предоставляет данные по различным метрикам городов, районов и кварталов, +которые могут быть полезны при оценке благоустройства определенной местности. ## Архитектура -Архитектуру проекта можно разделить на 4 части: -- База данных для хранения результатов анализа -- [ML модель](ml_research/README.md) для прогнозирования негативных аспектов -- [Frontend](frontend/README.md) для визуализации данных -- [Backend](backend/README.md) для предоставления доступа клиентам +Сервис состоит из трех основных частей: +- База данных для хранения геоданных (PostGis) +- [Backend](#backend) +- [Frontend](#frontend) +--- +### Backend +#### Описание +В качестве основного фреймворка был выбран `FastAPI`. Для взаимодействия с +PostGis используется `SQLAlchemy` (`GeoAlchemy`). Аутентификация пользователей осуществляется с помощью JWT. + +Сервис разделен на три основные части: +- Система авторизации пользователей +- Система для поиска геоданных +- Доп. функционал + + +### Frontend +#### Описание +Frontend сервиса отображает города и районы на карте, +также указывая на ней тепловую карту признаков основных метрик. + +В качестве фреймворка использовался `streamlit`, а для визуализации компонентов +карты пакет `folium`. + +--- + +## License +This project is [MIT](https://github.com/dsuhoi/pred-city-env/blob/main/LICENSE) licensed. diff --git a/backend/README.md b/backend/README.md deleted file mode 100644 index e70d0af..0000000 --- a/backend/README.md +++ /dev/null @@ -1,13 +0,0 @@ -# Backend сервиса - -## Цели -... - -## Архитектура -... - -## JSON:API -... - -## Примеры -... diff --git a/backend/requirements.txt b/backend/requirements.txt deleted file mode 100644 index e9a7a62..0000000 --- a/backend/requirements.txt +++ /dev/null @@ -1,41 +0,0 @@ -amqp==5.1.1 -anyio==3.7.0 -asyncpg==0.27.0 -billiard==4.1.0 -celery==5.3.1 -click==8.1.3 -click-didyoumean==0.3.0 -click-plugins==1.1.1 -click-repl==0.3.0 -fastapi==0.99.0 -geographiclib==2.0 -geopy==2.3.0 -graphql-core==3.2.3 -greenlet==2.0.2 -h11==0.14.0 -idna==3.4 -iniconfig==2.0.0 -kombu==5.3.1 -numpy==1.25.0 -packaging==23.1 -pandas==2.0.3 -pluggy==1.2.0 -prompt-toolkit==3.0.38 -psycopg2-binary==2.9.6 -pydantic==1.10.10 -pytest==7.4.0 -pytest-asyncio==0.21.0 -python-dateutil==2.8.2 -python-multipart==0.0.6 -pytz==2023.3 -redis==4.6.0 -six==1.16.0 -sniffio==1.3.0 -SQLAlchemy==1.4.48 -starlette==0.27.0 -strawberry-graphql==0.192.0 -typing_extensions==4.7.0 -tzdata==2023.3 -uvicorn==0.22.0 -vine==5.0.0 -wcwidth==0.2.6 diff --git a/docs/images/main_page.jpg b/docs/images/main_page.jpg new file mode 100644 index 0000000..72a4d08 Binary files /dev/null and b/docs/images/main_page.jpg differ diff --git a/frontend/Dockerfile b/frontend/Dockerfile index 16d5656..5c6b1d2 100644 --- a/frontend/Dockerfile +++ b/frontend/Dockerfile @@ -1,6 +1,6 @@ FROM python:3.10-slim -WORKDIR /frontend_mvp +WORKDIR /frontend_app RUN pip3 install poetry COPY *.py *.geojson poetry.lock pyproject.toml ./ diff --git a/frontend/README.md b/frontend/README.md deleted file mode 100644 index 9a2be6c..0000000 --- a/frontend/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# Frontend сервиса - -## Запуск -... - -## Компоненты -... diff --git a/ml_research/README.md b/ml_research/README.md deleted file mode 100644 index 3024b25..0000000 --- a/ml_research/README.md +++ /dev/null @@ -1,4 +0,0 @@ -# Анализ негативных аспектов развития городской среды - -... -Пункты анализа...