chat engine

Aviso de depreciação

O ChatEngine foi descontinuado sem planos para lançamentos adicionais. O suporte ao ChatEngine SDK terminará em 16 de julho de 2021. Se você tiver dúvidas sobre ChatEngine, entre em contato conosco em [email protected]. Por favor, visite nosso produto de bate -papo mais recente, Chat Pubnub.

Estrutura do Pubnub Chatengine

O Pubnub Chatengine é uma estrutura baseada em emissor de eventos orientada a objetos para criar aplicativos de bate-papo em JavaScript. Reduz o tempo para criar drasticamente os aplicativos de bate -papo e fornece componentes essenciais, como indicadores de digitação, monitoramento de presença on -line e histórico de mensagens fora da caixa.

O componente do servidor em tempo real é fornecido pelo Pubnub. O ChatEngine foi projetado para ser extensível e inclui uma estrutura de plug -in para simplificar a adição de novos recursos.

Para obter mais informações sobre como criar aplicativos de bate -papo com o Pubnub, consulte nosso Centro de Recursos de CHAT.

Documentação

Você pode encontrar os documentos completos no site da documentação.

Começando

Pré -requisitos

• Nodejs
• Bootstrap no Twitter
• jQuery
• ES6

Conta do PubNub configurada

Para configurar o ChatEngine no Pubnub, é preciso primeiro configurar uma chave do Pubnub. As etapas a seguir descrevem como configurar manualmente uma chave do Pubnub para trabalhar com os SDKs do ChatEngine Client.

Inscreva -se em uma conta do Pubnub

Se você ainda não possui uma conta, pode criar uma gratuitamente aqui.

Configure o serviço REST API usando funções do Pubnub

A estrutura do ChatEngine e os SDKs do lado do cliente interagem com um serviço de API REST que é executado como uma função Pubnub.

Você precisará configurar a função na sua conta do Pubnub antes de poder usar os SDKs.

Siga as instruções de configuração do ChatEngine Server.

Baixar código

Crie um novo projeto NPM

Como instalaremos dependências, é útil criar um novo package.json para acompanhar todos os pacotes que vamos instalar.

No seu diretório de projeto, execute este comando para criar um novo pacote. Conclua o guia de configuração interativo e estaremos prontos para ir.

 npm init

Isso criará um package.json no diretório do seu projeto.

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

Instale o Pubnub ChatEngine

Tudo bem, agora para a parte que você provavelmente nunca fez antes! Instale o Pubnub ChatEngine executando:

npm install chat-engine@latest --save

Recursos adicionais

Plugins

Confira a pia da cozinha do jQuery e os exemplos angulares da pia da cozinha para ver os plugins em ação.

• Uploads de imagens - usa o Serviço UployCare para fazer upload de imagens e renderizá -las em bate -papos. Exemplo.
• Suporte a Marydown - Renderize Markdown no HTML ao receber mensagens. Exemplo.
• Usuários mudo - permite que o usuário atual pare de receber eventos de outros usuários. Exemplo.
• Pesquisa de usuário on -line - uma maneira simples de pesquisar na lista de usuários on -line no bate -papo. Exemplo.
• Indicador de digitação - fornece métodos de conveniência que disparam quando um usuário inicia ou para de digitar. Exemplo
• Mensagens não lidas - permite marcar um bate -papo como estando em segundo plano e incrementa um contador à medida que os eventos são enviados para ele. Exemplo.
• Notificações de desktop - usa a API de notificação HTML5 para enviar atualizações "Toaster".
• O suporte emoji - usa imagens como um retorno para dispositivos que ainda não podem suportar?.
• Status do evento e recibos de leitura - emite eventos adicionais quando alguém lê recebe e/ou lê uma mensagem.
• GRAVATAR SUPORTE - Utiliza o serviço Gravatar para criar um avatar com base nas informações do estado do usuário.
• Nomes de usuário aleatórios- um plug-in que oferece a todos os usuários um nome de usuário aleatório de cor e um animal.

Vídeos

• Introdução do ChatEngine
• Tutorial de 5 minutos de chatengine
• Converse em 30 linhas de webinar de código

Tutoriais

JavaScript

• Tutorial de início.
• Chat - Exemplo de bate -papo realmente simples. O "Hello World" de ChatEngine.
• Lista on -line - sem bate -papo, basta renderizar que está online. Veja as pias da cozinha sobre como combinar isso com bate -papos privados.

Reagir nativo + celular

• Exemplo nativo reage-feito com create-react-app .
• React componentes nativos - componentes pré -fabricados para renderizar bate -papos, mensagens, usuários e muito mais.
• Integração em um aplicativo iOS existente - Guia para adicionar o aplicativo nativo do ChatEngine React ao iOS.
• Integração em um aplicativo Android existente - Guia sobre a adição de ChatEngine React Native App no Android.

Reagir

• React - Exemplo de Web de ossos nus.

Vue

• Guia do VUE - Guia sobre o uso do ChatEngine e Vue juntos. Usa os seguintes recursos.
• Exemplo de Vue - Exemplo completo de ChatEngine vue.
• VUE Plugin - Plugin ChatEngine para Vue.

Angular

• App angular simples - angular "Hello World". Aplicativo simples que usa um plug -in angular personalizado para renderizar quando algo é atualizado.
• Pia de cozinha angular - o maior aplicativo de demonstração do mercado, quase um clone completo de bate -papo em equipe de desktop (folga, stride, flowdock). URLs e persistentes se transformam em um aplicativo de desktop real com elétron!

jQuery

• JQuery Simple - JQuery Chatengine "Hello World" App. Um aplicativo simples onde todos conversam juntos.
• JQuery Kitchen Sink - Exemplo enorme que usa a maioria dos recursos do ChatEngine. Possui uma lista on -line que gera novos bate -papos quando você clica em nomes de usuário.

Autenticação de terceiros

• Login do Facebook - Use perfis do Facebook com ChatEngine.

Nodejs + chatbot

• Nodejs Chatbot - um bot de exemplo que responde a mensagens e emula a digitação. Funciona com o exemplo de pia da cozinha do jQuery por padrão.

Desenvolvimento

Clonagem

Repositórios de clone (enguias de bate-papo e plugins).

Todos os repositórios devem ser irmãos um do outro. Isso é necessário para renderizar os documentos corretamente.

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

Configurando o ambiente

 nvm use v6

Execute http-server do meu diretório /development , que possui todos os repositórios de chat-engine:

cd chat-engine

node server.js

Carregue http: // localhost: 8080 no navegador e navegue para/chat-mecan-amples/jQuery/Kitchen-Sink

Compilação

Execute gulp para compilar, mas você provavelmente deve executar gulp watch para obter mudanças consistentes.

Testes de execução

Você precisará atribuir variáveis de ambiente PUB_KEY_0 e SUB_KEY_0 às suas próprias teclas PubNub. Adicione essas variáveis ao seu .bashrc ou .zshrc .

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

Então, na pasta raiz, execute:

 gulp test

Liberando um patch (mecanismo de bate -papo e plugins)

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

Apoiar

• Se precisar de ajuda , tenha uma pergunta geral ou para arquivar um bug , entre em contato com [email protected]