Flatly Hotels — сервис поиска и аренды жилья

Многофункциональная платформа для поиска, подбора и бронирования квартир, домов, отелей и хостелов. Пользователь вводит свои пожелания на естественном языке, система определяет параметры и автоматически предлагает подходящие варианты через Telegram-бота и web-интерфейс.

---

Быстрый старт (для разработки)

0. INFO: .env файл нужно создать и в корне проекта, и в папке docker. Потому что docker не видит глобальный .env - файл.

1. Склонируйте репозиторий:

   git clone git@github.com:mur073/python-for-researcher.git
   cd python-for-researcher

2. Создайте файл переменных окружения:

   cp .env.example .env

   • Заполните .env своими значениями (пароли, токены, секреты).

3. Запустите сервисы через Docker Compose:

   cd docker
   docker-compose up -d

4. Проверьте работу сервисов:

   • Убедитесь, что база данных и backend работают (подробные инструкции — в соответствующих папках).
   • При необходимости проверьте логи:

     docker-compose logs db
     docker-compose logs backend

---

Описание папок

• database/ — SQL-скрипты создания и миграции БД, дампы, seed-данные.
• backend/ — Исходники backend-приложения, документация, зависимости.
• bot/ — Исходный код и зависимости Telegram-бота.
• docker/ — Dockerfile и docker-compose для развертывания всех сервисов.
• web/ (если используется) — Исходники web-интерфейса (статические файлы, шаблоны, исходники frontend).
• .env.example — Пример файла переменных окружения (шаблон).
• .gitignore — Файлы и папки, не включаемые в git.
• README.md — Этот файл.

---

Переменные окружения

• Все необходимые переменные перечислены в файле .env.example.
• Для локальной разработки создайте файл .env на основе .env.example и укажите свои значения.
• Для production используйте .env.prod с боевыми секретами (этот файл НЕ коммитится).
• Внимание: файлы .env, .env.prod и другие файлы с секретами уже добавлены в .gitignore.

---

Как делать миграции БД

• В папке database/ находятся скрипты и инструкции по созданию и миграции схемы БД.
• Применить базовый скрипт создания БД (через Docker):

  cat ../database/init.sql | docker exec -i <db_container_name> psql -U $POSTGRES_USER -d $POSTGRES_DB

• Для миграций с помощью ORM (Django, Alembic и т.д.) — читайте инструкцию внутри папки backend/.
• Для отката и seed-данных используйте соответствующие скрипты (seed_data.sql).

---

Работа с сервисами

• Backend:
  Инструкции по запуску, настройке зависимостей и документации — в папке backend/README.md.
• Bot:
  Инструкции по запуску и настройке Telegram-бота — в папке bot/README.md.
• Web:
  Инструкции для frontend/web-интерфейса — в папке web/README.md (если есть).

---

Вклад в проект

• Pull requests, issues и fork приветствуются!
• Перед коммитом убедитесь, что не добавляете в git:
  • .env, .env.prod, любые файлы с секретами и дампами данных,
  • временные, приватные и служебные файлы.
• Соблюдайте кодстайл и инструкции, изложенные в документации к каждой части проекта.

---

Лицензия

Здесь будет наша лицензия.

---

Контакты и поддержка

Добавьте сюда контакты команды или ссылки на техподдержку, если потребуется.

---

P.S.
README дополняется и расширяется по мере развития проекта.
Появятся новые сервисы — добавляйте описание, инструкции и документацию в соответствующие разделы!