Skip to content

Latest commit

 

History

History
89 lines (64 loc) · 2.96 KB

README.md

File metadata and controls

89 lines (64 loc) · 2.96 KB
Raw

Frontend Repo: comma-js-frontend

Comma Messenger (Server)

Comma JS Logo

An open source messenger based on Express, MongoDB and Socket.IO

Conversations Chat Page
plot plot

Is this another 'chat' app built based on YouTube examples? NO

Ok it's not that, so how does it standout?

  • Integrated Google Single Sign On for one-click user creation and login.💻
  • Splits - This means users have the ability have sub conversations inside threads. Think of a conversation like a browser window with multiple tabs open! 💭
  • Notifications support. 🔔
  • Spotify integration to preview song links sent in chat. 🎧

How to Run?

Backend:

  • Install all the dependencies by running npm install.
  • Execute command npm start.
  • Comma JS server should now be running on port 26398.

Sample .env file:

#Google App credentials
GOOGLE_CLIENT_ID=YourGoogleClientID
GOOGLE_CLIENT_SECRET=YourGoogleClientSecret

GOOGLE_APPLICATION_CREDENTIALS=./google-credentials.json

GOOGLE_BUCKET_NAME=gs://project-name.appspot.com/

#express session secret
SESSION_SECRET=YourSessionSecret

#MongoDB
MONGO_HOST=mongodb://localhost:27017
MONGO_DB_NAME=comma
MONGO_DB_NAME_TEST=comma_test

#URL of client web page
CLIENT_URL=http://127.0.0.1:5501

#URL of server
SERVER_URL=http://127.0.0.1:26398

#Encryption
CRYPT_KEY=YourEncryptionKey
CRYPT_IV=YourEncryptionIV

#vapidKeys for push notifications
VAPID_PUBLIC_KEY=YourVapidPublicKey
VAPID_PRIVATE_KEY=YourVapidPrivateKey

#Spotify
SPOTIFY_CLIENT_ID=YourSpotifyClientId
SPOTIFY_CLIENT_SECRET=YourSpotifyClientSecret

#TEST
API_PATH=/api/rest/v1
MONGO_OBJECT_ID_LENGTH=24

Where to get the env variables?

  1. Google App credentials: GOOGLE_CLIENT_ID, GOOGLE_CLIENT_SECRET and GOOGLE_APPLICATION_CREDENTIALS can be acquired from https://console.developers.google.com/, GOOGLE_BUCKET_NAME can be acquired by creating a new bucket on https://console.firebase.google.com/
  2. Encryption: Running preReq-CryptKeygen.js in the root of the project will generate a file named master-key.txt containing CRYPT_KEY and CRYPT_IV.
  3. vapidKeys: The following snippet can be used to generate vapidKeys: 
    const push = require("web-push");

let vapidKeys = push.generateVAPIDKeys();
console.log(vapidKeys);
  4. Spotify: Instructions here: https://developer.spotify.com/documentation/general/guides/app-settings/

API Documentation:

The REST and Socket API documentation can be found HERE

Samples:

  • Sample frontend implementations for important pieces of backend can be found in the demos folder.
  • Run the demo files on live server exstension for VS Code or any other server that runs on port 5501.