irfanshadikrishad / transponder-snail

Open Source MERN Stack chat app. The name transponder-snail is inspired by 'One Piece' communication device transponder snail AKA den-den-mushi.

transponder-snail

Open Source MERN Stack chat app. The name transponder-snail is inspired by 'One Piece' communication device transponder snail AKA den-den-mushi.

Features implemented in this chat app?

• Real-time chat.
• Login/Register user.
• Secure Authentication with JWT.
• See who's typing a message.
• Group Chat features.
• Protected routes.
• Last message on chat drawer.
• Search users to chat.
• See who's typing.
• Responsive/Mobile Friendly.
• ...

How to run locally?

To run locally in your own device first clone the repository:

git clone https://github.com/irfanshadikrishad/transponder-snail.git

Change the directory:

cd transponder-snail

there are two main directories for server and client, you will need to install the packages in each directory.

cd client

npm install

cd ../server

npm install

To run front-end in react:

npm run dev

then go to localhost where its running.

To run server go to server directory and run:

node server.js

or

nodemon server.js

if nodemon installed locally.

Environment Variables

PORT=
URI=
SALT=
SECRET=

What tech stacks are used?

• MongoDB (mongoose) for database
• ExpressJs for Server
• ReactJs for Front-End
• NodeJs as JavaScript runtime Environment
• Socket.io for Real-time chat

How to contribute?

For contribution, please follow this guide/instructions. Any contribution to improve this project is appreciated.

Thank You for visiting. (▀̿Ĺ̯▀̿ ̿)