chat.io

chat.io

Node.js、Express、Mongoose、Socket.io、Passport、Redis を使用して構築されたリアルタイム チャット アプリケーション。

索引

• デモ
• 特徴
• インストール
• 仕組み
• サポート
• 貢献する
• ライセンス

デモ

チェックデモ

特徴

• アプリケーションフレームワークとしてExpressを使用します。
• Express-session パッケージを使用してセッションを管理します。
• Passport を使用してユーザー名とパスワードで認証します。
• パスワードは bcrypt-nodejs パッケージを使用してハッシュされます。
• Passportを使用したFacebookおよびTwitterによるソーシャル認証。
• Socket.io を使用したクライアントとサーバー間のリアルタイム通信。
• データの保存とクエリには MongoDB、Mongoose、MongoLab(mLab) を使用します。
• connect-mongo を使用してセッションを MongoDB に保存します。 MongoDB ベースのセッション ストア。
• Redis を Socket.io のアダプターとして使用します。
• Winston を使用したエラーと例外のログ記録。

インストール

ローカルで実行する

Node.js と npm がインストールされていることを確認してください。

1. リポジトリのクローンを作成またはダウンロードする

   chat.io">

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

2. 依存関係のインストール

    $ npm install
   

3. app/config/config.jsonの構成ファイルを自分の認証情報を使用して編集します (「構成のセットアップ」を参照)。

4. Redisをダウンロードしてインストールします。

5. Redisサーバーの実行(管理者として)

    $ redis-server
   

6. アプリケーションを起動する

    $ npm start
   

これでアプリは localhost:3000 で実行されるはずです。

Heroku へのデプロイ

Heroku Toolbelt がインストールされていることを確認してください。

1. 新しい Heroku アプリケーションを作成し、チャット アプリケーションを Git リモート リポジトリにプッシュします。

    $ heroku create
   $ git push heroku master
   

   または

2. 次に、Heraku で構成変数を設定する必要があります。

   1. [設定] -> [構成変数の表示] に移動します。
   2. 構成変数を追加します。必要な変数はすべてapp/config/index.js内にあります。通常、割り当てる必要がある構成変数は、 { dbURI, sessionSecret, facebookClientID, facebookClientSecret, twitterConsumerKey, twitterConsumerSecret } (セットアップ構成を参照) です。

3. 最後のステップは、Redis を Heroku にアドオンとして追加することです。

   1. [リソース] -> [アドオン] に移動します。
   2. Heroku Redis を選択します

   アドオンが無料の場合でも、請求先アカウントを設定する必要があります。

4. ブラウザでチャット アプリケーションを開きます

    $ heroku open
   

仕組み

セットアップ構成

実稼働環境の構成は Heroku の環境変数から割り当てられますが、開発環境の構成はapp/config/config.jsonファイル内に存在します。

MongoDB と MongoLab

MongoLab でデータベースを作成し、次にデータベース ユーザーを作成し、 MongoDB URI取得して、それをdbURIに割り当てる必要があります。

フェイスブックとツイッター

ユーザーがアプリケーションへのアクセスを許可し、ソーシャル アカウントを使用してログインできるトークンを取得するには、Facebook と Twitter の両方に新しいアプリケーションを登録する必要があります。

Facebookにアプリを登録する

1. Facebook 開発者に移動
2. 新しいアプリを追加し、必要な情報を入力します。
3. App ID 、 App Secretを取得します。
4. [製品の追加] -> [Facebook ログイン] -> [有効な OAuth リダイレクト URI] に移動します。
5. 有効なコールバック URI を追加する
6. [アプリのレビュー] -> [アプリケーションを公開] に移動します。

これで、 App ID facebookClientIDに、 App SecretをfacebookClientSecretに割り当てることができます。

Twitterにアプリを登録する

1. Twitter アプリに移動
2. 新しいアプリを作成し、必要な情報を入力します。
3. Web サイトとコールバック URL を追加
4. Consumer KeyとConsumer Secret取得します。

これで、 Consumer Key twitterConsumerKeyに割り当て、 Consumer Secret twitterConsumerSecretに割り当てることができます。

コールバック URL

• ローカルホストを指すこともできます。 http://localhost:3000/auth/facebook/callback

• Heroku にデプロイすると、次のようになります。 http://my-chat-app.herokuapp.com/auth/facebook/callback

セッション

ブラウザ内のセッション ID がランダムであることを確認するには、セッションにはランダムな文字列が必要です。このランダムな文字列は、ブラウザでセッション ID を暗号化するために使用されます。なぜですか?セッション ID の推測を防ぐため。

データベース

Mongoose は、MongoLab によってホストされている MongoDB と対話するために使用されます。

スキーマ

2 つのスキーマがあります。ユーザーも部屋も。

各ユーザーはユーザー名、パスワード、ソーシャル ID、写真を持っています。ユーザーがユーザー名とパスワードを使用してログインしている場合、ソーシャル ID は null である必要があり、ソーシャル アカウントを介してログインしている場合、パスワードは null になります。

各部屋にはタイトルと一連の接続があります。接続配列内の各項目は、一意のソケットを介して接続されているユーザーを表します。 {userId +ソケットId}で構成されるオブジェクト。両方ともユニークです。

モデル

各モデルは Mongoose Model オブジェクトをラップし、いくつかのメソッドをオーバーライドして提供します。 2 つのモデルがあります。ユーザーとルーム。

セッション

Express アプリケーションのセッションは、express-session パッケージを使用して管理するのが最適です。セッション データはコンピューター上にローカルに保存されますが、実稼働環境のデータベースには保存されます。ログアウトするとセッションデータは削除されます。

ユーザー認証

ユーザーは、ユーザー名とパスワードを使用してログインするか、ソーシャル アカウント経由でログインできます。ユーザー認証はパスポートを使用して行われます。 Passport には、各認証方法の実装方法に関する詳細なステップバイステップのドキュメントが含まれています。

ソケット

クライアントとサーバーの間でアクティブな接続が開かれ、クライアントがデータを送受信できるようになります。これにより、TCP ソケットを使用したリアルタイム通信が可能になります。これは Socket.io によって可能になります。

クライアントは、ソケット (特定の名前空間に割り当てられている場合もあります) を介してサーバーに接続することから始まります。接続が成功すると、クライアントとサーバーはイベントを発行してリッスンできるようになります。

2 つの名前空間が使用されます。 /roomsと/chatroom 。

ロガー

言うまでもなく、アプリケーションを監視する必要があります。 Winston は、キャッチされない例外をログに記録してキャッチできます。すべてのログはコンソールに表示され、 debug.logファイルに保存されます。

Heroku では、アプリケーション ダッシュボードの左上にある[詳細] -> [ログの表示]をクリックしてログを監視できます。

サポート

このスクリプトは勉強中の自由時間に書きました。役立つと思われた場合は、広めてプロジェクトをサポートしてください。

貢献する

新しい問題を作成するか、Github でプル リクエストを送信するか、[email protected] に電子メールを送信して貢献してください。

ライセンス

MIT ライセンスに基づいて構築されています。