💬 Colloquy Chat Application

About the project

Colloquy is a web based chat application that allows user to perform private text chat as well as private video chat directly from the browser without the use of any external plugin or software installation. The UI has been designed to be simple and easy to use for the novice computer users.

🔧 Built With

• The frontend or the client side has been built using React.
• The backend server is build using Node.js and Express.js.
• Socket.io handles the communication between the server and the clients in realtime.
• MongoDB is used as the database solution to store the chat messages
• WebRTC and Simple peer package is used to incorporate the private video chat feature in the application.

🐣 Prerequisites

The application doesn't require any prerequisites if its a hosted version. However to run the project from the system make sure you have Node.js installed on your system.

⚡ Execution guide

Server side first

1. Download the contents of the repository
2. Locate to the server directory
3. Type the following command inside the server directory on your terminal

npm install

4. After the required dependencies have finished the installation execute

node index.js

Client side

1. Locate to the frontend directory
2. Type the following command inside the frontend directory on your terminal

 npm install

3. After the required dependencies have finished the installation execute

npm run start

👨‍💻 Usage

Landing Page

Login

Private Chat

Private Video Calling

Logging Out

Retrieving Database Messages

Emojis

🤝 Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

📝 Contact