chat.io

chat.io

Eine Echtzeit-Chat-Anwendung, die mit Node.js, Express, Mongoose, Socket.io, Passport und Redis erstellt wurde.

Index

• Demo
• Merkmale
• Installation
• Wie es funktioniert
• Unterstützung
• Beitragen
• Lizenz

Demo

Demo ansehen

Merkmale

• Verwendet Express als Anwendungs-Framework.
• Verwaltet Sitzungen mithilfe des Express-Session-Pakets.
• Authentifiziert über Benutzername und Passwort mit Passport.
• Passwörter werden mit dem bcrypt-nodejs-Paket gehasht.
• Soziale Authentifizierung über Facebook und Twitter mit Passport.
• Echtzeitkommunikation zwischen einem Client und einem Server mithilfe von Socket.io.
• Verwendet MongoDB, Mongoose und MongoLab (mLab) zum Speichern und Abfragen von Daten.
• Speichert Sitzungen in einer MongoDB mit connect-mongo; ein MongoDB-basierter Sitzungsspeicher.
• Verwendet Redis als Adapter für Socket.io.
• Protokollieren von Fehlern und Ausnahmen mit Winston.

Installation

Lokal ausgeführt

Stellen Sie sicher, dass Node.js und npm installiert sind.

1. Klonen Sie das Repository oder laden Sie es herunter

   chat.io">

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

2. Abhängigkeiten installieren

    $ npm install
   

3. Bearbeiten Sie die Konfigurationsdatei in app/config/config.json mit Ihren Anmeldeinformationen (siehe Setup-Konfigurationen).

4. Laden Sie Redis herunter und installieren Sie es.

5. Ausführen des Redis-Servers (als Administrator)

    $ redis-server
   

6. Starten Sie die Anwendung

    $ npm start
   

Ihre App sollte jetzt auf localhost:3000 ausgeführt werden.

Bereitstellung für Heroku

Stellen Sie sicher, dass Sie den Heroku Toolbelt installiert haben.

1. Erstellen Sie eine neue Heroku-Anwendung und übertragen Sie Ihre Chat-Anwendung in ein Git-Remote-Repository

    $ heroku create
   $ git push heroku master
   

   oder

2. Jetzt müssen Sie Konfigurationsvariablen auf Heroku einrichten.

   1. Gehen Sie zu Einstellungen -> Konfigurationsvariablen anzeigen.
   2. Konfigurationsvariablen hinzufügen. Alle benötigten Variablen befinden sich in app/config/index.js . Normalerweise sind dies die Konfigurationsvariablen, die Sie zuweisen müssen: { dbURI, sessionSecret, facebookClientID, facebookClientSecret, twitterConsumerKey, twitterConsumerSecret } (siehe Setup-Konfigurationen).

3. Ein letzter Schritt besteht darin, Redis als Add-on zu Heroku hinzuzufügen.

   1. Gehen Sie zu Ressourcen -> Add-ons
   2. Wählen Sie Heroku Redis aus

   Sie müssen ein Rechnungskonto einrichten, auch wenn das Add-on kostenlos ist.

4. Öffnen Sie Ihre Chat-Anwendung im Browser

    $ heroku open
   

Wie es funktioniert

Setup-Konfigurationen

Die Konfigurationen für die Produktion werden von Umgebungsvariablen auf Heroku zugewiesen, während sich die Entwicklungskonfigurationen in der Datei app/config/config.json befinden.

MongoDB und MongoLab

Sie müssen eine Datenbank auf MongoLab erstellen, dann einen Datenbankbenutzer erstellen, den MongoDB URI abrufen und ihn dbURI zuweisen.

Facebook und Twitter

Sie müssen eine neue Anwendung sowohl auf Facebook als auch auf Twitter registrieren, um Ihre Token zu erhalten, mit denen Benutzer Zugriff auf Ihre Anwendung gewähren und sich mit ihren sozialen Konten anmelden können.

Registrieren der App auf Facebook

1. Gehen Sie zu Facebook-Entwicklern
2. Fügen Sie eine neue App hinzu und geben Sie die erforderlichen Informationen ein.
3. Holen Sie sich Ihre App ID und App Secret .
4. Gehen Sie zu Produkt hinzufügen -> Facebook-Anmeldung -> Gültige OAuth-Weiterleitungs-URIs
5. Fügen Sie gültige Rückruf-URIs hinzu
6. Gehen Sie zu App Review -> Machen Sie Ihre Anwendung öffentlich.

Jetzt können Sie die App ID facebookClientID und App Secret facebookClientSecret zuweisen.

Registrieren der App auf Twitter

1. Gehen Sie zu Twitter-Apps
2. Erstellen Sie eine neue App und geben Sie die erforderlichen Informationen ein.
3. Fügen Sie eine Website und eine Rückruf-URL hinzu
4. Holen Sie sich Ihren Consumer Key , Consumer Secret .

Jetzt können Sie den Consumer Key twitterConsumerKey und Consumer Secret twitterConsumerSecret zuweisen.

Die Rückruf-URL

• Es kann auf Ihren lokalen Host verweisen. http://localhost:3000/auth/facebook/callback

• Bei der Bereitstellung in Heroku sieht etwas so aus: http://my-chat-app.herokuapp.com/auth/facebook/callback

Sitzung

Die Sitzung benötigt eine zufällige Zeichenfolge, um sicherzustellen, dass die Sitzungs-ID im Browser zufällig ist. Diese zufällige Zeichenfolge wird verwendet, um die Sitzungs-ID im Browser zu verschlüsseln. Warum? Um das Erraten der Sitzungs-ID zu verhindern.

Datenbank

Mongoose wird verwendet, um mit einer MongoDB zu interagieren, die von MongoLab gehostet wird.

Schemata

Es gibt zwei Schemata; Benutzer und Räume.

Jeder Benutzer hat einen Benutzernamen, ein Passwort, eine soziale ID und ein Bild. Wenn der Benutzer über Benutzername und Passwort angemeldet ist, muss die soziale ID null sein, und wenn er über ein soziales Konto angemeldet ist, ist das Passwort null.

Jeder Raum hat einen Titel und eine Reihe von Verbindungen. Jedes Element im Array „Verbindungen“ stellt einen Benutzer dar, der über einen eindeutigen Socket verbunden ist. Objekt bestehend aus {userId + socketId} . Beide zusammen sind einzigartig.

Modelle

Jedes Modell umschließt das Mongoose-Modellobjekt, überschreibt es und stellt einige Methoden bereit. Es gibt zwei Modelle; Benutzer und Raum.

Sitzung

Sitzungen in Express-Anwendungen werden am besten mit dem Express-Session-Paket verwaltet. Sitzungsdaten werden lokal auf Ihrem Computer gespeichert, während sie in der Datenbank der Produktionsumgebung gespeichert werden. Beim Abmelden werden die Sitzungsdaten gelöscht.

Benutzerauthentifizierung

Der Benutzer kann sich entweder mit einem Benutzernamen und einem Passwort anmelden oder sich über ein soziales Konto anmelden. Die Benutzerauthentifizierung erfolgt über Passport. Passport verfügt über eine ausführliche und schrittweise Dokumentation zur Implementierung der einzelnen Authentifizierungsmethoden.

Steckdosen

Zwischen dem Client und dem Server muss eine aktive Verbindung geöffnet sein, damit der Client Daten senden und empfangen kann. Dies ermöglicht eine Echtzeitkommunikation über TCP-Sockets. Dies wird durch Socket.io ermöglicht.

Der Client verbindet sich zunächst über einen Socket mit dem Server (möglicherweise auch einem bestimmten Namespace zugeordnet). Sobald die Verbindung erfolgreich ist, können Client und Server Ereignisse ausgeben und abhören.

Es werden zwei Namespaces verwendet; /rooms und /chatroom .

Logger

Und es ist nicht selbstverständlich, dass Sie Ihre Anwendung überwachen müssen. Winston kann nicht abgefangene Ausnahmen protokollieren und abfangen. Alle Protokolle werden in der Konsole angezeigt und in der Datei debug.log gespeichert.

Auf Heroku können Sie die Protokolle überwachen, indem Sie oben links in Ihrem Anwendungs-Dashboard auf Mehr -> Protokolle anzeigen klicken.

Unterstützung

Ich habe dieses Skript in meiner Freizeit während meines Studiums geschrieben. Wenn Sie es nützlich finden, unterstützen Sie das Projekt bitte, indem Sie es verbreiten.

Beitragen

Tragen Sie bei, indem Sie neue Issues erstellen, Pull-Requests auf Github senden oder eine E-Mail an [email protected] senden

Lizenz

Gebaut unter MIT-Lizenz.