m0L3cuL3/Cynergy

Cynergy

Cynergy is a real-time chat application that allows multiple users to communicate with each other and provides a real-time web editor. It also supports cross-platform application. Desktop version of Cynergy is found here

Supported Platforms

Web
Windows (7/8/8.1/10)
Linux (Debian-Based)

Technologies Used

Cynergy is built with the following technologies:

Front-end	Back-end
Material Design	NodeJS
Bootstrap	ExpressJS
Jquery	SockJS

For the desktop version, Cynergy is built with Electron

Objectives

The following are the objectives of Cynergy.

To provide a platform for users to communicate with different users.
To provide a platform for users to code and preview real-time.

Features

The following are the features of Cynergy.

Real-time web editor
Real-time messaging
Private messaging
User mentions
Message deletion (administrator)
Kick/Ban users (administrator)
See user IP address (administrator)
Emoji support
Dark mode

User Levels

User
VIP (can delete messages)
Moderator (can kick/ban users)
Administrator (all of the above)

Commands

User Commands

/pm <user> <message>			    Sends private message to specific user.
/me <message> or /em <message>		Send message in italic.
/shrug <message>			        Send message with '¯\_(ツ)_/¯'
/name <message>				        Change username.
/user					            Show connected users.
/help					            Show help dialog.
/clear					            Clear message history.
/reconnect				            Reconnects user to the server.

Administrator Commands

/alert <message>			    Alerts everyone in chat.
/kick <user>				    Kicks user from the server.
/ban <user> <minutes>			Bans user from the server in number of minutes.
/role <user> <0-3>			    Change user role.

Console Commands

Note: Execute role command first in the console in order for administrators to assign roles to other users.

/role <user>				Change user role.

Usage

Install package dependencies using npm.

npm i or npm install

Start server

npm start

Go to http://localhost:3000

Note: The port number can be change in config.json.

Deploying using ngrok.

Download ngrok.

https://ngrok.com/download

Start server (Cynergy).

npm start

Start ngrok (Windows).

ngrok.exe http <port-of-server>

Note: The port is probably 3000.

Open link generated by ngrok.

Contributions

Groups

Group 7
Group 4

m0L3cuL3 / Cynergy