{"id":17930949,"url":"https://github.com/dmitriiviktorov/instantmessages","last_synced_at":"2026-04-08T21:31:27.296Z","repository":{"id":258354528,"uuid":"873497258","full_name":"DmitriiViktorov/InstantMessages","owner":"DmitriiViktorov","description":"Instant messaging service. FastApi + Websocket + Postgresql + Redis + Celery. Register and chat with other users.","archived":false,"fork":false,"pushed_at":"2024-11-01T12:23:34.000Z","size":104,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-08T23:45:37.809Z","etag":null,"topics":["aiogram-bot","alembic","celery","docker","fastapi","nginx","postgresql","redis","websocket"],"latest_commit_sha":null,"homepage":"","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/DmitriiViktorov.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}},"created_at":"2024-10-16T09:13:28.000Z","updated_at":"2024-11-01T12:23:38.000Z","dependencies_parsed_at":"2024-10-25T10:03:12.916Z","dependency_job_id":"3699ea16-6844-472d-8a5c-3bbb3bcf12b6","html_url":"https://github.com/DmitriiViktorov/InstantMessages","commit_stats":null,"previous_names":["dmitriiviktorov/instantmessages"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DmitriiViktorov%2FInstantMessages","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DmitriiViktorov%2FInstantMessages/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DmitriiViktorov%2FInstantMessages/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DmitriiViktorov%2FInstantMessages/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DmitriiViktorov","download_url":"https://codeload.github.com/DmitriiViktorov/InstantMessages/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246982598,"owners_count":20864128,"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":["aiogram-bot","alembic","celery","docker","fastapi","nginx","postgresql","redis","websocket"],"created_at":"2024-10-28T21:18:44.088Z","updated_at":"2026-04-08T21:31:27.255Z","avatar_url":"https://github.com/DmitriiViktorov.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Сервис обмена мгновенными сообщениями\n![instant-messages-logo](app/static/logo.png)\n\nСервис обмена мгновенными сообщениями\n\n## Возможности сервиса\n\nСервис представляет собой приложение для общения с любым пользователем в режиме реального времени.\nДля начала общения необходимо зарегистрироваться и перейти в раздел Chats (чаты).\nОбратите внимание, что при регистрации необходимо указать ваш telegram аккаунт. \nЭто нужно для того, чтобы вы могли общаться с нашим ботом, где вы сможите подписаться на уведомление о новых сообщениях,\nесли вы не онлайн.\n\n## Установка\n\nСервис мгновенных сообщений разворачивается с помощью запуска нескольких взаимосвязанных контейнеров:\n\n- `web`: само приложение с логикой работы, эндпоинтами и методами \nвзаимодействия с базой данных, а так же телеграм бот и очередь задач на celery.\n- `postgres`: СУБД PostgreSQL, где хранится вся информация о пользователях и сообщениях.\n- `nginx`: Nginx обеспечивает централизованную маршрутизацию, балансировку нагрузки и работу со статическими файлами.\n\n### Шаги установки:\n\n1. **Клонирование репозитория:**\n   \n   Для установки необходимо клонировать репозиторий с помощью следующей команды:\n   ```bash\n   git clone https://github.com/DmitriiViktorov/InstantMessages.git\n    ```\n\n2. **Создание .env файла**\n\n   После клонирования репозитория в корневой директории проекта необходимо создать \n   .env файл и указать там следующие типы настроек:\n\n   - POSTGRES_USER=\u003c ваше имя пользователя \u003e\n   - POSTGRES_PASSWORD=\u003c ваш пароль для этого пользователя \u003e\n   - POSTGRES_DB=\u003c название базы данных \u003e\n   - POSTGRES_HOST=db\n   - POSTGRES_PORT=5432\n\n   - AUTH_SECRET=\u003cваша_строка_для_шифрования_данных_аутентификации\u003e\n     (пример: 'mVFJwu9PpL2s?a1yviK0eIHMtc5!,k_bfgh6Br.YEx8GZRSD7jMbsoWEXfgJz05_RqCKinZSP6eLDNvhmG2YHA9-?p!ryjkdITu8')\n   \n   - PASSWORD_RESET=\u003cваша_строка_для_шифрования_токенов_сброса_пароля\u003e\n     (привер: '5lbiPzhV_74TeEyw0nuAKWmZFJv?xO!pMXaRSH6,IBG3j1L8cU')\n   \n   - BOT_TOKEN=\u003cваш_телеграм_бот_токен\u003e\n     (как зарегистрировать свой телеграм-бот: https://t.me/botfather)\n\n3. **Запуск сервиса**\n   \n    После перехода в корневую директорию проекта запустите сервис с помощью Docker Compose:\n    ```bash\n    docker-compose up --build\n    ```\n\n4. **Доступ к приложению**\n\n    После успешного запуска сервис будет доступен по адресу http://localhost.\n\n\n## Использование\n\nПосле запуска сервиса им сразу можно пользоваться по прямому назначению. \nПосле регистрации пользователь увидит страницу своего профиля, на которой будет ссылка на телеграм бот InstantMessages,\nгде он сможет подписаться на получение уведомлений.\nПерейдя в раздел Chats пользователь выбирает другого пользователя для начала общения и переходит в чат с ним.\n\n\n## Описание API\n\nAPI данного приложения документировано с использованием OpenAPI. \nДля ознакомления с документацией API, перейдя по следующей ссылке:\n\n- [Документация API](http://localhost:5050/docs)\n\n\n## Контактная информация\n\nВ случае возникновения вопросов, комментариев, замечаний по работе приложения вы можете связаться со мной:\n- Email: viktorovokrl@gmail.com\n- Github: https://github.com/DmitriiViktorov/twitter\n- Telegram: https://t.me/ViktorovDV\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdmitriiviktorov%2Finstantmessages","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdmitriiviktorov%2Finstantmessages","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdmitriiviktorov%2Finstantmessages/lists"}