Added README.md.

dsuhoi · Jul 22, 2023 · 4545fd3 · 4545fd3
1 parent 1ade2ab
commit 4545fd3
Show file tree

Hide file tree

Showing 7 changed files with 36 additions and 75 deletions.
diff --git 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)
+>Сервис по прогнозированию негативных аспектов развития городской среды.
+<img src="docs/images/main_page.jpg" width=800>
 
-## Цели
-...
+---
+## Идея
+Сервис предоставляет данные по различным метрикам городов, районов и кварталов,
+которые могут быть полезны при оценке благоустройства определенной местности.
 
 ## Архитектура
-Архитектуру проекта можно разделить на 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
diff --git a/backend/requirements.txt b/backend/requirements.txt
diff --git a/docs/images/main_page.jpg b/docs/images/main_page.jpg
diff --git 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
diff --git a/ml_research/README.md b/ml_research/README.md