chat.io

chat.io

Una aplicación de chat en tiempo real creada con Node.js, Express, Mongoose, Socket.io, Passport y Redis.

Índice

• Manifestación
• Características
• Instalación
• Cómo funciona
• Apoyo
• Contribuir
• Licencia

Manifestación

Ver demostración

Características

• Utiliza Express como marco de la aplicación.
• Gestiona sesiones utilizando el paquete express-session.
• Se autentica mediante nombre de usuario y contraseña mediante Passport.
• Las contraseñas se codifican mediante el paquete bcrypt-nodejs.
• Autenticación social a través de Facebook y Twitter mediante Passport.
• Comunicación en tiempo real entre un cliente y un servidor mediante Socket.io.
• Utiliza MongoDB, Mongoose y MongoLab(mLab) para almacenar y consultar datos.
• Almacena la sesión en MongoDB usando connect-mongo; un almacén de sesiones basado en MongoDB.
• Utiliza Redis como adaptador para Socket.io.
• Registro de errores y excepciones con Winston.

Instalación

Ejecutando localmente

Asegúrese de tener Node.js y npm instalados.

1. Clonar o descargar el repositorio

   chat.io">

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

2. Instalar dependencias

    $ npm install
   

3. Edite el archivo de configuración en app/config/config.json con sus credenciales (consulte Configuraciones de instalación).

4. Descargue e instale Redis.

5. Ejecutando Redis Server (como administrador)

    $ redis-server
   

6. Iniciar la aplicación

    $ npm start
   

Su aplicación ahora debería estar ejecutándose en localhost:3000.

Implementación en Heroku

Asegúrate de tener instalado Heroku Toolbelt.

1. Cree una nueva aplicación Heroku y envíe su aplicación de chat a un repositorio remoto de Git

    $ heroku create
   $ git push heroku master
   

   o

2. Ahora, necesitas configurar variables de configuración en Heroku.

   1. Vaya a Configuración -> Revelar variables de configuración.
   2. Agregar variables de configuración. Todas las variables necesarias están dentro de app/config/index.js . Normalmente, estas son las variables de configuración que necesita asignar: { dbURI, sessionSecret, facebookClientID, facebookClientSecret, twitterConsumerKey, twitterConsumerSecret } (consulte Configuraciones de configuración).

3. Un último paso es agregar Redis como complemento en Heroku.

   1. Vaya a Recursos -> Complementos
   2. Seleccione Heroku Redis

   Debes configurar una cuenta de facturación incluso si el complemento es gratuito.

4. Abra su aplicación de chat en el navegador

    $ heroku open
   

Cómo funciona

Configuraciones de instalación

Las configuraciones en producción se asignarán desde Variables de entorno en Heroku, mientras que las configuraciones de desarrollo residen dentro del archivo app/config/config.json .

MongoDB y MongoLab

Debe crear una base de datos en MongoLab, luego crear un usuario de base de datos, obtener el MongoDB URI y asignarlo a dbURI .

Facebook y Twitter

Debe registrar una nueva aplicación tanto en Facebook como en Twitter para obtener sus tokens mediante los cuales los usuarios pueden otorgar acceso a su aplicación e iniciar sesión usando sus cuentas sociales.

Registrar la aplicación en Facebook

1. Ir a desarrolladores de Facebook
2. Agregue una nueva aplicación y complete la información requerida.
3. Obtenga su App ID , App Secret .
4. Vaya a Agregar producto -> Inicio de sesión con Facebook -> URI de redireccionamiento de OAuth válidos
5. Agregar URI de devolución de llamada válidas
6. Vaya a Revisión de la aplicación -> Haga pública su aplicación.

Ahora, puede asignar el App ID a facebookClientID y App Secret a facebookClientSecret .

Registrar la aplicación en Twitter

1. Ir a aplicaciones de Twitter
2. Cree una nueva aplicación y complete la información requerida.
3. Agregar sitio web y URL de devolución de llamada
4. Obtenga su Consumer Key , Consumer Secret .

Ahora, puede asignar la Consumer Key a twitterConsumerKey y Consumer Secret a twitterConsumerSecret .

La URL de devolución de llamada

• Puede apuntar a su servidor local; http://localhost:3000/auth/facebook/callback

• Cuando lo implementes en Heroku, tendrás algo parecido a esto; http://my-chat-app.herokuapp.com/auth/facebook/callback

Sesión

La sesión necesita una cadena aleatoria para garantizar que la identificación de la sesión en el navegador sea aleatoria. Esa cadena aleatoria se utiliza para cifrar la identificación de la sesión en el navegador, ¿por qué? Para evitar adivinar la identificación de la sesión.

Base de datos

Mongoose se utiliza para interactuar con MongoDB alojado en MongoLab.

esquemas

Hay dos esquemas; usuarios y salas.

Cada usuario tiene un nombre de usuario, contraseña, identificación social e imagen. Si el usuario inicia sesión mediante nombre de usuario y contraseña, entonces la identificación social debe ser nula y, si inicia sesión a través de una cuenta social, la contraseña será nula.

Cada habitación tiene un título y una variedad de conexiones. Cada elemento de la matriz de conexiones representa un usuario conectado a través de un socket único; objeto compuesto por {userId + socketId} . Ambos juntos son únicos.

Modelos

Cada modelo envuelve el objeto Mongoose Model, lo anula y proporciona algunos métodos. Hay dos modelos; Usuario y Sala.

Sesión

La sesión en aplicaciones Express se gestiona mejor utilizando el paquete express-session. Los datos de la sesión se almacenan localmente en su computadora, mientras que se almacenan en la base de datos en el entorno de producción. Los datos de la sesión se eliminarán al cerrar sesión.

Autenticación de usuario

El usuario puede iniciar sesión utilizando un nombre de usuario y contraseña, o iniciar sesión a través de una cuenta social. La autenticación del usuario se realiza mediante Passport. Passport tiene documentación extensa y paso a paso sobre cómo implementar cada forma de autenticación.

Enchufes

Tener una conexión activa abierta entre el cliente y el servidor para que el cliente pueda enviar y recibir datos. Esto permite la comunicación en tiempo real mediante sockets TCP. Esto es posible gracias a Socket.io.

El cliente comienza conectándose al servidor a través de un socket (tal vez también asignado a un espacio de nombres específico). Una vez que las conexiones son exitosas, el cliente y el servidor pueden emitir y escuchar eventos.

Se utilizan dos espacios de nombres; /rooms y /chatroom .

registrador

Y no hace falta decir que necesita monitorear su aplicación. Winston puede registrar y detectar excepciones no detectadas. Todos los registros se muestran en la consola y se guardan en el archivo debug.log .

En Heroku, puede monitorear los registros haciendo clic en Más -> Ver registros en la parte superior izquierda del panel de su aplicación.

Apoyo

He escrito este guión en mi tiempo libre durante mis estudios. Si lo encuentra útil, apoye el proyecto difundiendo el mensaje.

Contribuir

Contribuya creando nuevos problemas, enviando solicitudes de extracción en Github o puede enviar un correo electrónico a: [email protected]

Licencia

Construido bajo licencia MIT.