An open API service indexing awesome lists of open source software.

https://github.com/mrinal-xx-singha/pingme

PingMe is a real-time web application for seamless communication, built using modern web technologies like React, Node.js, and MongoDB.
https://github.com/mrinal-xx-singha/pingme

cloudinary cookie-parser express jwt lucide-react mongodb nodejs react react-hot-toast react-router-dom socket-io tailwindcss

Last synced: 3 months ago
JSON representation

PingMe is a real-time web application for seamless communication, built using modern web technologies like React, Node.js, and MongoDB.

Awesome Lists containing this project

README

          

# PingMe

Real-time Communication App

**PingMe** is a real-time web application for seamless communication, built using modern web technologies like React, Node.js, and MongoDB. It supports secure authentication, dynamic notifications, and a responsive UI, delivering a user-friendly experience.

## Features

* **Real-Time Messaging:** Built with Socket.io for instant updates.
* **Secure Authentication:** Protected routes using JWT and cookies.
* **Responsive UI:** Styled with TailwindCSS for mobile-friendly design.
* **Cloud-Based Media Management:** Integrated with Cloudinary.
* **Interactive Notifications:** Using React-Hot-Toast.
## 🚀 About Me
I'm a aspiring full stack developer...

## 🔗 Links
[![portfolio](https://img.shields.io/badge/my_portfolio-000?style=for-the-badge&logo=ko-fi&logoColor=white)](https://mrinalspersonalportfolio.netlify.app//)
[![linkedin](https://img.shields.io/badge/linkedin-0A66C2?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/mrinal-singha-754b57249/)

## Tech Stack

### Frontend
* React.js
* React Router DOM
* TailwindCSS
* React-Hot-Toast

### Backend
* Node.js
* Express.js
* MongoDB
* JWT Authentication
* Socket.io
* Cookie Parser
* Cloudinary (for media uploads)
## Getting Started

Follow these steps to set up the project locally.

### Prerequisites

* Node.js installed
* MongoDB instance running locally or on the cloud

### Installation

1. Clone this repository:
```bash
git clone [https://github.com/Mrinal-xx-Singha/PingMe.git](https://github.com/Mrinal-xx-Singha/PingMe.git)

1. Navigate into the project directory:
```bash
cd PingMe

3. Install dependencies for both backend and frontend:
```bash
cd backend && npm install
cd ../frontend && npm install

### Configuration

Create a .env file in the backend directory with the following:


MONGO_URI=your_mongodb_connection_string
JWT_SECRET=your_jwt_secret
CLOUDINARY_NAME=your_cloudinary_name
CLOUDINARY_API_KEY=your_api_key
CLOUDINARY_API_SECRET=your_api_secret

## Running the Project

Start the backend server:


cd backend
npm start

Start the frontend development server:

cd frontend
npm start

## Contributing
Contributions are welcome! Fork this repository and submit a pull request for any improvements or fixes.
## Licence

This project is licensed under the MIT License. See the LICENSE 1 file for details.
## Contributing

Contributions are always welcome!

See `contributing.md` for ways to get started.

Please adhere to this project's `code of conduct`.