Live Wave

A web application which enables user to enter chat rooms without requiring personal information.

Badges

Demo

Try it out here

File structure

root/
│
├── client/
│   ├── Dockerfile
|   |-- .dockerignore
│   ├── package.json
│   ├── public/
│   └── src/
|         |-- components/
|         |-- assets/ 
│         |-- helpers/
|         |-- pages/
|         |-- socket/
|         |-- utils/
|         |-- App.jsx
|         |-- *
|
├── server/
│   ├── Dockerfile
|   |-- .dockerignore
│   ├── package.json
|   |-- socket/
|   |-- chat/
|   |-- socket.js
|   |-- server.js
|   |-- *
|
|--Readme.md

Features

• Send real-time message using websockets
• Chat wall
• Doesn't require user credentials and easy to try out without requiring registration or login process.
• Emoji support
• Encrypted messages for secured communication between users.

Screenshots

• Enter username

• Home

Environment Variables

To run this project, you will need to add the following environment variables to your .env file to the respective directories

• Client

VITE_API_ENDPOINT - Endpoint for the server

VITE_EN_SECRET - Secret key for encryption

• Server

MONGODB_URI - URI for mongodb database (local) or Atlas EXPRESS_PORT - PORT for the express server CLIENT_ENDPOINT - Endpoint of the client

Local development

Getting started with project normally

• Fork the repository
• Clone your fork in your local machine git clone <url>.git
• Run npm install inside the folders containing package.json file
• To run the client npm run dev
• To run the server npm run dev or nodemon

Getting started using docker

• For client cd into client containing docker-compose.yaml file.
• Run docker compose --env-file ./client/.env up to spin up the container where .env contains all the enviromental variables
• .env for client contains VITE_API_ENDPOINT
• Same steps to be followed for server where .env contains MONGODB_URI,JWT_SECRET

FAQ

Will I need to login with user name?

No, the username with which you will be entering the web app is not saved in our database. You can use any name of your choice.

Will my message be completely secured ?

We are following an industry standard encryption mechanism but we will advise you to not share any personal or confidential information.

Can I join multiple rooms in one session ?

Yes. By default users are able to interact in "General". They can join all the rooms if they like and can also exit the rooms.

Authors

• @suman373

Feedback

If you would like to contribute to the project, feel free to create an issue and tag me. For feedbacks reach out to me at iamsuman898@gmail.com