chat.io

chat.io

Приложение для чата в реальном времени, созданное с использованием Node.js, Express, Mongoose, Socket.io, Passport и Redis.

Индекс

• Демо
• Функции
• Установка
• Как это работает
• Поддерживать
• Способствовать
• Лицензия

Демо

Проверить демо

Функции

• Использует Express в качестве платформы приложения.
• Управляет сессиями с помощью пакета экспресс-сессий.
• Аутентифицируется по имени пользователя и паролю с помощью Passport.
• Пароли хешируются с помощью пакета bcrypt-nodejs.
• Социальная аутентификация через Facebook и Twitter с использованием Passport.
• Связь в реальном времени между клиентом и сервером с помощью Socket.io.
• Использует MongoDB, Mongoose и MongoLab(mLab) для хранения и запроса данных.
• Сохраняет сеанс в MongoDB с помощью Connect-Mongo; хранилище сеансов на базе MongoDB.
• Использует Redis в качестве адаптера для Socket.io.
• Регистрация ошибок и исключений с помощью Winston.

Установка

Запуск локально

Убедитесь, что у вас установлены Node.js и npm.

1. Клонировать или загрузить репозиторий

   chat.io">

    $ git clone https://github.com/OmarElGabry/chat.io.git
   $ cd chat.io
   

2. Установить зависимости

    $ npm install
   

3. Отредактируйте файл конфигурации в app/config/config.json, указав свои учетные данные (см. Конфигурации настройки).

4. Загрузите и установите Redis.

5. Запуск сервера Redis (от имени администратора)

    $ redis-server
   

6. Запустить приложение

    $ npm start
   

Теперь ваше приложение должно работать на локальном хосте: 3000.

Развертывание в Heroku

Убедитесь, что у вас установлен Heroku Toolbelt.

1. Создайте новое приложение Heroku и переместите приложение чата в удаленный репозиторий Git.

    $ heroku create
   $ git push heroku master
   

   или

2. Теперь вам нужно настроить переменные конфигурации в Heroku.

   1. Зайдите в «Настройки» -> «Показать переменные конфигурации».
   2. Добавьте переменные конфигурации. Все необходимые переменные находятся внутри app/config/index.js . Обычно вам необходимо назначить следующие переменные конфигурации: { dbURI, sessionSecret, facebookClientID, facebookClientSecret, twitterConsumerKey, twitterConsumerSecret } (см. Конфигурации настройки).

3. Последний шаг — добавить Redis в качестве дополнения к Heroku.

   1. Перейдите в Ресурсы -> Дополнения.
   2. Выберите Героку Редис

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

4. Откройте приложение чата в браузере

    $ heroku open
   

Как это работает

Конфигурации настройки

Конфигурации для производства будут назначены из переменных среды на Heroku, а конфигурации разработки находятся в файле app/config/config.json .

МонгоБД и МонгоЛаб

Вам необходимо создать базу данных в MongoLab, затем создать пользователя базы данных, получить MongoDB URI и назначить его dbURI .

Фейсбук и Твиттер

Вам необходимо зарегистрировать новое приложение на Facebook и Twitter, чтобы получить токены, с помощью которых пользователи смогут предоставлять доступ к вашему приложению, и входить в систему, используя свои учетные записи в социальных сетях.

Регистрация приложения на Facebook

1. Перейти к разработчикам Facebook
2. Добавьте новое приложение и заполните необходимую информацию.
3. Получите свой App ID , App Secret .
4. Перейдите в раздел «Добавить продукт» -> «Вход в Facebook» -> «Действительные URI перенаправления OAuth».
5. Добавьте действительные URI обратного вызова
6. Перейдите в раздел «Обзор приложения» -> «Сделайте свое приложение общедоступным».

Теперь вы можете назначить App ID facebookClientID и App Secret facebookClientSecret .

Регистрация приложения в Твиттере

1. Перейти в приложения Твиттера
2. Создайте новое приложение и заполните необходимую информацию.
3. Добавить веб-сайт и URL обратного вызова
4. Получите свой Consumer Key , Consumer Secret .

Теперь вы можете назначить Consumer Key twitterConsumerKey и Consumer Secret twitterConsumerSecret .

URL-адрес обратного вызова

• Он может указывать на ваш локальный хост; http://localhost:3000/auth/facebook/обратный вызов

• При развертывании в Heroku вы будете выглядеть примерно так: http://my-chat-app.herokuapp.com/auth/facebook/callback

Сессия

Сеансу нужна случайная строка, чтобы идентификатор сеанса в браузере был случайным. Эта случайная строка используется для шифрования идентификатора сеанса в браузере. Почему? Чтобы предотвратить угадывание идентификатора сеанса.

База данных

Mongoose используется для взаимодействия с MongoDB, размещенной на MongoLab.

Схемы

Есть две схемы; пользователи и комнаты.

У каждого пользователя есть имя пользователя, пароль, социальный идентификатор и изображение. Если пользователь входит в систему с помощью имени пользователя и пароля, тогда социальный идентификатор должен быть нулевым, а если вход в систему осуществляется через учетную запись социальной сети, то пароль будет нулевым.

Каждая комната имеет название и множество связей. Каждый элемент массива соединений представляет пользователя, подключенного через уникальный сокет; объект, состоящий из {userId +ocketId} . Они оба вместе уникальны.

Модели

Каждая модель оборачивает объект модели Mongoose, переопределяет и предоставляет некоторые методы. Есть две модели; Пользователь и комната.

Сессия

Сеансами в приложениях Express лучше всего управлять с помощью пакета express-session. Данные сеанса хранятся локально на вашем компьютере, а также в базе данных производственной среды. Данные сеанса будут удалены при выходе из системы.

Аутентификация пользователя

Пользователь может войти в систему, используя имя пользователя и пароль, или войти через учетную запись в социальной сети. Аутентификация пользователя осуществляется с помощью Passport. В Passport имеется обширная пошаговая документация по реализации каждого способа аутентификации.

Розетки

Наличие активного соединения, открытого между клиентом и сервером, чтобы клиент мог отправлять и получать данные. Это позволяет осуществлять связь в реальном времени с использованием TCP-сокетов. Это стало возможным благодаря Socket.io.

Клиент начинается с подключения к серверу через сокет (возможно, также присвоенный определенному пространству имен). После успешного подключения клиент и сервер могут генерировать и прослушивать события.

Используются два пространства имен; /rooms и /chatroom .

Регистратор

И само собой разумеется, вам нужно следить за своим приложением. Winston может регистрировать и перехватывать неперехваченные исключения. Все журналы отображаются в консоли и сохраняются в файле debug.log .

В Heroku вы можете отслеживать журналы, нажав «Дополнительно» -> «Просмотреть журналы» в левом верхнем углу панели управления приложения.

Поддерживать

Я написал этот сценарий в свободное время во время учебы. Если вы найдете это полезным, пожалуйста, поддержите проект, распространив информацию.

Способствовать

Внесите свой вклад, создавая новые задачи, отправляя запросы на включение на Github или отправляя электронное письмо по адресу: [email protected].

Лицензия

Построен по лицензии MIT.