chat engine

Уведомление об исчезновении

ChatEngine был устарел без планов по дополнительным выпускам. Поддержка ChatEngine SDK закончится 16 июля 2021 года. Если у вас есть вопросы о Chatengine, пожалуйста, свяжитесь с нами по адресу [email protected]. Пожалуйста, посетите наш более новый чат, Pubnub Chat.

Pubnub Chatengine Framework

PubNub Chatengine-это объектно-ориентированная структура на основе излучающего средства на основе Event Emutter для приложений в сфере строительного чата в JavaScript. Это сокращает время для строительства приложений в чате и предоставляет важные компоненты, такие как индикаторы печати, мониторинг присутствия в Интернете и история сообщений из коробки.

Компонент сервера в реальном времени обеспечивается PubNub. ChatEngine разработан, чтобы быть расширяемым и включает в себя плагинную структуру для облегчения добавления новых функций.

Для получения дополнительной информации о приложениях строительного чата с PubNub см. В нашем центре ресурсов чата.

Документация

Вы можете найти полные документы на веб -сайте документации.

Начиная

Предварительные условия

• Nodejs
• Twitter Bootstrap
• jQuery
• ES6

Настройка учетной записи PubNub

Чтобы настроить ChatEngine на Pubnub, нужно сначала настроить ключ PubNub. На следующих шагах описывается, как вручную настроить ключ Pubnub для работы с Catengine Client SDK.

Зарегистрируйтесь на учетной записи PubNub

Если у вас еще нет учетной записи, вы можете создать его бесплатно здесь.

Настройка службы API REST с использованием функций PubNub

Структура чата и SDK на стороне клиента взаимодействуют с службой API REST, которая работает как функция PubNub.

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

Следуйте инструкциям настройки сервера ChatEngine.

Загрузить код

Создать новый проект NPM

Поскольку мы будем устанавливать зависимости, полезно создать новый package.json Json, чтобы отслеживать все пакеты, которые мы собираемся установить.

В своем каталоге проекта запустите эту команду, чтобы создать новый пакет. Заполните интерактивное руководство по настройке, и мы будем готовы к работе.

 npm init

Это создаст package.json в вашем каталоге проекта.

{
  "name" : " chat-engine-tutorial " ,
  "version" : " 0.0.1 " ,
  "description" : " An example PubNub ChatEngine Tutorial " ,
  "main" : " index.js " ,
  "author" : " Ian Jennings "
}

Установите Pubnub Chatengine

Хорошо, теперь для части, которую вы, вероятно, никогда не делали раньше! Установите Pubnub Chatengine, работая:

npm install chat-engine@latest --save

Дополнительные ресурсы

Плагины

Проверьте кухонную раковину jQuery и примеры угловой кухонной раковины, чтобы увидеть плагины в действии.

• Загрузка изображения - использует службу oploadcare для загрузки изображений и отображения их в чатах. Пример.
• Поддержка Markdown - рендеринг Marckdown в HTML при получении сообщений. Пример.
• Mute Users - позволяет текущему пользователю прекратить получать события от других пользователей. Пример.
• Поиск онлайн -пользователя - простой способ поиска в списке пользователей в Интернете в чате. Пример.
• Индикатор печати - предоставляет удобные методы, которые стреляют, когда пользователь начинает или прекращает печатать. Пример
• Непрочитанные сообщения - позволяет отметить чат как находящийся в заднем плане и приращения счетчика при отправке событий. Пример.
• Уведомления на рабочем столе - использует обновления HTML5 уведомлений для отправки «Toaster».
• Поддержка Emoji - использует изображения в качестве запасного для устройств, которые еще не поддерживают?
• Статус события и квитанции о чтении - издает дополнительные события, когда кто -то читает получения и/или читает сообщение.
• Поддержка Gravatar - использует сервис Gravatar для создания аватара на основе информации о состоянии пользователя.
• Случайные имена пользователей- плагин, который дает каждому пользователю случайное имя пользователя, объединяющее цвет и животное.

Видео

• Чатгиновый вступление
• 5 -минутный учебник по чату
• Чат в 30 строках кодового вебинара

Учебные пособия

JavaScript

• Начало работы.
• Чат - действительно простой пример чата. «Привет, мир» чата.
• Список онлайн - без чатов, просто рендерирует, кто онлайн. Посмотрите на кухонные раковины, чтобы объединить это с частными чатами.

Отреагировать Native + Mobile

• Реактируйте родной пример-сделанный с помощью create-react-app .
• React Native Components - готовые компоненты для рендеринга чатов, сообщений, пользователей и многого другого.
• Интеграция в существующее приложение для iOS - руководство по добавлению нативного приложения ChatEngine React в iOS.
• Интеграция в существующее приложение Android - Руководство по добавлению Native Catengine React Native App в Android.

Реагировать

• React - голые кости реагируют пример.

Vue

• Руководство VUE - Руководство по использованию ChatEngine и Vue вместе. Использует следующие ресурсы.
• Пример VUE - Полный пример ChatEngine Vue.
• Плагин Vue - плагин ChatEngine для Vue.

Угловой

• Angular Simple - Angular "Hello World" приложение. Простое приложение, которое использует пользовательский угловой плагин для рендеринга, когда что -то обновляет.
• Угловая кухонная раковина - самое большое демонстрационное приложение, почти полное клон командного чата настольных компьютеров (Slack, Stride, Flowdock). Постоянные URL -адреса и приводят в реальное настольное приложение с электроном!

jQuery

• jQuery Simple - jquery Chatengine "Hello World". Простое приложение, где все общаются вместе.
• Кухонная раковина jQuery - Огромный пример, который использует большинство функций ChatEngine. Имеет онлайн -список, который порождает новые чаты, когда вы нажимаете на имена пользователей.

Сторонняя аутентификация

• Вход в Facebook - используйте профили Facebook с Chatengine.

Nodejs + Чатбот

• Nodejs Chatbot - пример бота, который отвечает на сообщения и имитирует печатание. Работает с примером кухонной раковины jQuery по умолчанию.

Разработка

Клонирование

Clone Repos (чат-двигатель и плагины).

Все репо должны быть братьями и сестрами друг друга. Это требуется для правильного отображения документов.

 chat-engine
chat-engine-desktop-notifications
chat-engine-emoji
chat-engine-examples
//...

Настройка среды

 nvm use v6

Запустите http-server из моего /development , в котором есть все репозиции в чате:

cd chat-engine

node server.js

Загрузите http: // localhost: 8080 в браузере и перейдите к/чат-инжерализации/jquery/witchen-sink

Компиляция

Запустите gulp , чтобы скомпилировать, но вы, вероятно, должны запустить gulp watch чтобы получить последовательные изменения.

Заводящие тесты

Вам нужно будет назначить переменные среды PUB_KEY_0 и SUB_KEY_0 вашим собственным ключам pubnub. Добавьте эти переменные в свой .bashrc или .zshrc .

 # pubnub chatengine keys
export PUB_KEY_0= " YOUR PUBNUB PUBLISH KEY "
export SUB_KEY_0= " YOUR PUBNUB SUBSCRIBE KEY "

Затем в корневой папке запускается:

 gulp test

Выпуск патча (двигатель чата и плагины)

 npm version patch && git push origin master --tags

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

• Если вам нужна помощь , у вас есть общий вопрос или подать ошибку , свяжитесь с [email protected]