Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/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.
https://github.com/irfanshadikrishad/transponder-snail
chatapp express mern-stack mongodb nodejs react
Last synced: 13 days ago
JSON representation
Open Source MERN Stack chat app. The name transponder-snail is inspired by 'One Piece' communication device transponder snail AKA den-den-mushi.
- Host: GitHub
- URL: https://github.com/irfanshadikrishad/transponder-snail
- Owner: irfanshadikrishad
- Created: 2024-01-25T23:49:57.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-05-23T07:30:11.000Z (6 months ago)
- Last Synced: 2024-05-23T08:39:03.383Z (6 months ago)
- Topics: chatapp, express, mern-stack, mongodb, nodejs, react
- Language: JavaScript
- Homepage: https://transponder-snail.vercel.app
- Size: 743 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
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:
```ada
git clone https://github.com/irfanshadikrishad/transponder-snail.git
```
Change the directory:
```ada
cd transponder-snail
```
there are two main directories for server and client, you will need to install the packages in each directory.
```ada
cd client
```
```ada
npm install
```
```ada
cd ../server
```
```ada
npm install
```
To run front-end in react:
```ada
npm run dev
```
then go to [localhost](http://localhost:5173) where its running.
To run server go to server directory and run:
```ada
node server.js
```
or
```ada
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. (▀̿Ĺ̯▀̿ ̿)