chat.io

chat.io

แอปพลิเคชันแชทแบบเรียลไทม์ที่สร้างโดยใช้ Node.js, Express, Mongoose, Socket.io, Passport และ Redis

ดัชนี

• การสาธิต
• คุณสมบัติ
• การติดตั้ง
• มันทำงานอย่างไร
• สนับสนุน
• มีส่วนช่วย
• ใบอนุญาต

การสาธิต

ตรวจสอบการสาธิต

คุณสมบัติ

• ใช้ Express เป็นกรอบงานแอปพลิเคชัน
• จัดการเซสชันโดยใช้แพ็คเกจเซสชันด่วน
• ตรวจสอบสิทธิ์ผ่านชื่อผู้ใช้และรหัสผ่านโดยใช้ Passport
• รหัสผ่านถูกแฮชโดยใช้แพ็คเกจ bcrypt-nodejs
• การรับรองความถูกต้องทางสังคมผ่าน Facebook และ Twitter โดยใช้ Passport
• การสื่อสารแบบเรียลไทม์ระหว่างไคลเอนต์และเซิร์ฟเวอร์โดยใช้ Socket.io
• ใช้ MongoDB, Mongoose และ MongoLab(mLab) สำหรับจัดเก็บและสืบค้นข้อมูล
• จัดเก็บเซสชันใน MongoDB โดยใช้ Connect-mongo ที่เก็บเซสชั่นที่ใช้ 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. ตอนนี้คุณต้องตั้งค่าตัวแปรการกำหนดค่าบน Heroku

   1. ไปที่การตั้งค่า -> เปิดเผย Config Vars
   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 -> URI การเปลี่ยนเส้นทาง OAuth ที่ถูกต้อง
5. เพิ่ม URI การติดต่อกลับที่ถูกต้อง
6. ไปที่การตรวจสอบแอป -> ทำให้แอปพลิเคชันของคุณเป็นแบบสาธารณะ

ตอนนี้คุณสามารถกำหนด App ID ให้กับ facebookClientID และ App Secret ให้กับ facebookClientSecret ได้

การลงทะเบียนแอปบน Twitter

1. ไปที่แอพ Twitter
2. สร้างแอปใหม่และกรอกข้อมูลที่จำเป็น
3. เพิ่มเว็บไซต์และ 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

การประชุม

เซสชันต้องการสตริงแบบสุ่มเพื่อให้แน่ใจว่ารหัสเซสชันในเบราว์เซอร์นั้นเป็นแบบสุ่ม สตริงสุ่มนั้นใช้เพื่อเข้ารหัสรหัสเซสชันในเบราว์เซอร์ เพราะเหตุใด เพื่อป้องกันการคาดเดารหัสเซสชัน

ฐานข้อมูล

Mongoose ใช้เพื่อโต้ตอบกับ MongoDB ที่โฮสต์โดย MongoLab

สคีมา

มีสองสคีมา; ผู้ใช้และห้อง

ผู้ใช้แต่ละคนมีชื่อผู้ใช้ รหัสผ่าน รหัสโซเชียล และรูปภาพ หากผู้ใช้เข้าสู่ระบบด้วยชื่อผู้ใช้และรหัสผ่าน รหัสโซเชียลจะต้องเป็นโมฆะ และหากเข้าสู่ระบบผ่านบัญชีโซเชียล รหัสผ่านจะเป็นโมฆะ

แต่ละห้องมีชื่อและการเชื่อมต่อที่หลากหลาย แต่ละรายการในอาร์เรย์การเชื่อมต่อแสดงถึงผู้ใช้ที่เชื่อมต่อผ่านซ็อกเก็ตเฉพาะ วัตถุที่ประกอบด้วย {userId + socketId} ทั้งสองอย่างรวมกันมีเอกลักษณ์เฉพาะตัว

โมเดล

แต่ละโมเดลจะล้อมอ็อบเจ็กต์ Mongoose Model แทนที่ และจัดเตรียมวิธีการบางอย่าง มีสองรุ่น; ผู้ใช้และห้อง

การประชุม

เซสชันในแอปพลิเคชัน Express ได้รับการจัดการได้ดีที่สุดโดยใช้แพ็คเกจเซสชันด่วน ข้อมูลเซสชันจะถูกจัดเก็บไว้ในคอมพิวเตอร์ของคุณ ในขณะที่จัดเก็บไว้ในฐานข้อมูลในสภาพแวดล้อมการใช้งานจริง ข้อมูลเซสชันจะถูกลบเมื่อออกจากระบบ

การรับรองความถูกต้องของผู้ใช้

ผู้ใช้สามารถเข้าสู่ระบบโดยใช้ชื่อผู้ใช้และรหัสผ่านหรือเข้าสู่ระบบผ่านบัญชีโซเชียล การรับรองความถูกต้องของผู้ใช้ทำได้โดยใช้ Passport Passport มีเอกสารที่ครอบคลุมและเป็นขั้นตอนเกี่ยวกับวิธีการใช้การรับรองความถูกต้องแต่ละวิธี

ซ็อกเก็ต

การเปิดการเชื่อมต่อที่ใช้งานระหว่างไคลเอนต์และเซิร์ฟเวอร์เพื่อให้ไคลเอนต์สามารถส่งและรับข้อมูลได้ ช่วยให้สามารถสื่อสารแบบเรียลไทม์โดยใช้ซ็อกเก็ต TCP สิ่งนี้เกิดขึ้นได้โดย Socket.io

ไคลเอนต์เริ่มต้นด้วยการเชื่อมต่อกับเซิร์ฟเวอร์ผ่านซ็อกเก็ต (อาจกำหนดให้กับเนมสเปซเฉพาะด้วย) เมื่อการเชื่อมต่อสำเร็จ ไคลเอนต์และเซิร์ฟเวอร์สามารถปล่อยและฟังเหตุการณ์ได้

มีสองเนมสเปซที่ใช้; /rooms และ /chatroom

คนตัดไม้

และจะไม่ดำเนินไปโดยไม่บอก คุณต้องตรวจสอบแอปพลิเคชันของคุณ Winston สามารถบันทึกและตรวจจับ Uncaught Exceptions ได้ บันทึกทั้งหมดจะแสดงในคอนโซล และบันทึกในไฟล์ debug.log

บน Heroku คุณสามารถตรวจสอบบันทึกได้โดยคลิกที่ เพิ่มเติม -> ดูบันทึก ที่ด้านซ้ายบนของแดชบอร์ดแอปพลิเคชันของคุณ

สนับสนุน

ฉันเขียนสคริปต์นี้ในเวลาว่างระหว่างเรียน หากเห็นว่ามีประโยชน์กรุณาสนับสนุนโครงการด้วยการบอกต่อ

มีส่วนช่วย

มีส่วนร่วมโดยการสร้างประเด็นใหม่ ส่งคำขอดึงบน Github หรือคุณสามารถส่งอีเมลได้ที่: [email protected]

ใบอนุญาต

สร้างขึ้นภายใต้ใบอนุญาต MIT