From 16b771b890eeddec8e634d164770468ec77e5fdf Mon Sep 17 00:00:00 2001 From: "a.k.lysenko" Date: Fri, 14 Nov 2025 01:32:14 +0300 Subject: [PATCH] add readme --- README.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/README.md b/README.md index f025a08..64bb6b6 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,46 @@ # ITMO TRIP Веб-сервис для организации совместных поездок в ИТМО + +# Описание +На дорогу до мест проведения пар у студентов уходит время. Непрерывно заниматься учебными или рабочими задачи в пути невозможно из-за частого переключения контекста. Однако это время можно потратить на знакомство с другими студентами и нетворкинг. + +Предлагается создать систему, в которой любой студент сможет опубликовать “объявление”, содержащее: ++ имя; ++ фотографию из системы myitmo; ++ факультет и курс обучения; ++ желаемое время начала прибытия в ИТМО, с возможностью быстрой установки времени начала (завершения) пары; ++ корпус ИТМО; ++ место, из которого он будет добираться до корпуса (место проживания) -- в виде адреса или названия крупного объекта (станции метро); ++ дату поездки; ++ вид транспорта; ++ регулярность поездки; ++ контакты (свой никнейм в телеграм); ++ дополнительную информацию о себе. ++ Студенты смогут смотреть все записи, фильтровать их по нужным параметрам и договариваться о совместных поездках. Поездки зачастую будут повторяющимися: договорившись один раз, студенты смогут совместно ездить на пары в течение семестра. + +# Функциональность проекта +Аутентификация в сервисе осуществляется с использованием учетной записи ITMO ID. Тем самым мы гарантируем, что объявления, опубликованные студентами, доступны к просмотру только другим студентам ИТМО. + +После прохождения процедуры аутентификации веб-сервис предоставляет для пользователя следующую функциональность: + ++ опубликовать, редактировать и удалить своё объявление о поездке; ++ просматривать ленту своих объявлений; ++ просматривать ленту объявлений других пользователей с возможностью гибкой фильтрации. + +# Ссылки ++ [Модель хранилища данных проекта](https://github.com/itmo-trip/itmo.trip/wiki/Database-model) ++ [Макет главной страницы проекта](https://github.com/itmo-trip/itmo.trip/wiki/Frontend-layout) ++ [Диаграмма компонентов проекта](https://github.com/itmo-trip/itmo.trip/wiki/Application-architecture-(component-diagram)) ++ [Презентация](https://docs.google.com/presentation/d/1W_lKwVE1OW6iOqgJHRFm_nR-ceUDa1NDXiXU-ECfWMg/edit?usp=sharing) + +# Инструкция по сборке +1) Перейти в директорию `local-env` +```bash + cd ./local-env +``` +2) Запустить контейнеры +```bash + docker compose up -d . +``` +3) Перейти в браузере по адресу `http://localhost:5177` \ No newline at end of file