chat engine

Avis de dépréciation

Le chatengin a été obsolète sans plans pour des versions supplémentaires. La prise en charge du SDK chatengin se terminera le 16 juillet 2021. Si vous avez des questions sur le chatengin, veuillez nous contacter à [email protected]. Veuillez visiter notre nouveau produit de chat, PubNub Chat.

Framework Pubnub Chaurinne

PubNub Chagenine est un cadre basé sur l'émetteur d'événements orienté objet pour la création d'applications de chat en JavaScript. Il réduit le temps pour créer de manière radicale les applications de chat et fournit des composants essentiels comme les indicateurs de saisie, la surveillance de la présence en ligne et l'historique des messages hors de la boîte.

Le composant de serveur en temps réel est fourni par PubNub. Le chatengine est conçu pour être extensible et comprend un framework de plugin pour faciliter l'ajout de nouvelles fonctionnalités.

Pour plus d'informations sur la création d'applications de chat avec PubNub, consultez notre centre de ressources de chat.

Documentation

Vous pouvez trouver les documents complets sur le site Web de la documentation.

Commencer

Condition préalable

• Nodejs
• Twitter bootstrap
• jquery
• ES6

Configuration du compte PubNub

Pour configurer le chatenne sur PubNub, il faut d'abord configurer une clé PubNub. Les étapes suivantes décrivent comment configurer manuellement une clé PubNub pour travailler avec les SDK côté client du chautisme.

Inscrivez-vous à un compte PubNub

Si vous n'avez pas déjà de compte, vous pouvez en créer un gratuitement ici.

Configurez le service API REST à l'aide des fonctions PubNub

Le framework chatenne et les SDK côté client interagissent avec un service API REST qui s'exécute comme une fonction PubNub.

Vous devrez configurer la fonction sur votre compte PubNub avant de pouvoir utiliser les SDK.

Suivez les instructions de configuration du serveur chatenan.

Télécharger le code

Créer un nouveau projet NPM

Étant donné que nous installerons des dépendances, il est utile de créer un nouveau package.json pour garder une trace de tous les packages que nous allons installer.

Dans votre répertoire de projet, exécutez cette commande pour créer un nouveau package. Terminez le guide de configuration interactif et nous serons prêts à partir.

 npm init

Cela créera un package.json dans votre répertoire de projet.

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

Installer Pubnub Chaurinne

Très bien, maintenant pour la pièce que vous n'avez probablement jamais faite auparavant! Installez Pubnub Chautinne en fonctionnant:

npm install chat-engine@latest --save

Ressources supplémentaires

Plugins

Découvrez l'évier de la cuisine jQuery et les exemples d'évier de cuisine angulaire pour voir les plugins en action.

• Téléchargements d'images - utilise le service UploadCare pour télécharger des images et les rendre dans des chats. Exemple.
• Prise en charge de Markdown - Rendez Markdown dans HTML lors de la réception de messages. Exemple.
• Utilisateurs de mute - permet à l'utilisateur actuel d'arrêter de recevoir des événements d'autres utilisateurs. Exemple.
• Recherche d'utilisateurs en ligne - un moyen simple de rechercher dans la liste des utilisateurs en ligne dans le chat. Exemple.
• Indicateur de typage - fournit des méthodes de commodité qui tirent lorsqu'un utilisateur démarre ou arrête de taper. Exemple
• Messages non lus - vous permet de marquer un chat comme étant en arrière-plan et incréments un compteur à mesure que les événements y sont envoyés. Exemple.
• Notifications de bureau - utilise l'API de notification HTML5 pour envoyer des mises à jour "grille-pain".
• Prise en charge des emoji - utilise les images comme secours pour les appareils qui pourraient ne pas encore prendre en charge ?.
• État de l'événement et reçus de lecture - émet des événements supplémentaires lorsque quelqu'un lit un reçoit et / ou lit un message.
• Support Gravatar - utilise le service Gravatar pour créer un avatar basé sur les informations de l'état de l'utilisateur.
• Noms d'utilisateur aléatoires - un plugin qui donne à chaque utilisateur un nom d'utilisateur aléatoire combinant la couleur et un animal.

Vidéos

• Intro de châtegine
• Tutoriel de château de 5 minutes
• Chat dans 30 lignes de code webinaire

Tutoriels

Javascrip

• Tutoriel de démarrage.
• CHAT - Exemple de chat vraiment simple. Le "Hello World" du chatengin.
• Liste en ligne - pas de chats, ne rend que qui est en ligne. Voir les éviers de cuisine pour comment combiner cela avec des chats privés.

React natif + mobile

• React Native Exemple - Fabriqué avec create-react-app .
• React Composants natifs - Composants préfabriqués pour rendre les chats, les messages, les utilisateurs, etc.
• Intégration dans une application iOS existante - Guide sur l'ajout de l'application native React Chauntine dans iOS.
• Intégration dans une application Android existante - Guide sur l'ajout de l'application native React Chauntine React dans Android.

Réagir

• React - Bare Bones React Web Exemple.

Vue

• Guide Vue - Guide sur l'utilisation du chatengin et de Vue ensemble. Utilise les ressources suivantes.
• Vue Exemple - Exemple complet de chautennine Vue.
• Plugin Vue - Plugin chaulangeur pour Vue.

Angulaire

• Angular Simple - Angular "Hello World" App. Application simple qui utilise un plugin angulaire personnalisé pour rendre lorsque quelque chose se met à jour.
• Évier de cuisine angulaire - la plus grande application de démonstration, presque un clone de chat d'équipe de bureau complet (Slack, Stride, Flowdock). URL persistants et se rend dans une véritable application de bureau avec électron!

jquery

• JQUERY Simple - JQuery Chaugenne "Hello World" App. Une application simple où tout le monde discute ensemble.
• Évier de cuisine jQuery - Exemple énorme qui utilise la plupart des fonctionnalités du château. A une liste en ligne qui engendre de nouveaux chats lorsque vous cliquez sur les noms d'utilisateur.

Authentification tierce

• Connexion Facebook - Utilisez les profils Facebook avec le chatengin.

Nodejs + chatbot

• Nodejs Chatbot - Un exemple de bot qui répond aux messages et émule la frappe. Fonctionne avec l'exemple de l'évier de la cuisine jQuery par défaut.

Développement

Clonage

Clone Repos (Chat-Engin and Plugins).

Tous les références devraient être des frères et sœurs les uns des autres. Ceci est requis pour rendre correctement les documents.

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

Configuration de l'environnement

 nvm use v6

Exécutez http-server à partir de mon répertoire /development qui a tous les référentiels de chat:

cd chat-engine

node server.js

Chargez http: // localhost: 8080 dans le navigateur et accédez à / chat-engine-examples / jQuery / Kitchen-Sink

Compilation

Exécutez gulp pour compiler, mais vous devriez probablement exécuter gulp watch pour obtenir des modifications cohérentes.

Tests en cours d'exécution

Vous devrez attribuer des variables d'environnement PUB_KEY_0 et SUB_KEY_0 à vos propres clés PubNub. Ajoutez ces variables dans votre .bashrc ou .zshrc .

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

Ensuite, dans le dossier racine Run:

 gulp test

Libérer un patch (moteur de chat et plugins)

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

Soutien

• Si vous avez besoin d'aide , ayez une question générale ou pour déposer un bogue , contactez [email protected]