Skip to content

Commit 0888942

Browse files
authored
Update README.md
1 parent b076f53 commit 0888942

File tree

1 file changed

+29
-22
lines changed

1 file changed

+29
-22
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 29 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,44 @@
1-
# CommUnity
1+
# πŸ’¬ CommUnity
22

3-
### A Real-Time Chat Application
3+
### A Real-Time πŸ” Encrypted Chat Application
44

5-
CommUnity is a robust and user-friendly chat application designed to foster seamless communication. Built with modern web technologies, it offers a real-time messaging experience, secure authentication, and efficient media handling.
5+
**CommUnity** is a secure, scalable, and user-friendly chat application designed to enable seamless real-time communication. Built with modern technologies like **React**, **Node.js**, **Firebase**, and **MongoDB**, it offers encrypted messaging using **AES**, image sharing via **Cloudinary**, and a responsive UI that adapts to all screen sizes.
66

77
---
88

9-
## Features
9+
## πŸš€ Features
1010

11-
- **Real-Time Messaging**: Instant communication between users.
12-
- **Secure Authentication**: User authentication powered by Firebase.
13-
- **Media Uploads**: Efficient image handling with Cloudinary.
14-
- **Scalable Database**: MongoDB for storing user and message data.
15-
- **Responsive Design**: Works seamlessly on all device sizes.
11+
- πŸ”’ **AES Message Encryption**: Every message is encrypted using **AES (Advanced Encryption Standard)** to ensure end-to-end privacy and security.
12+
- πŸ”„ **Real-Time Messaging (via Polling)**: Instant message updates using efficient client-side polling in place of WebSockets.
13+
- βœ… **Firebase Authentication**: Secure, reliable user login and registration using **Firebase Auth**.
14+
- πŸ–ΌοΈ **Media Upload Support**: Easily upload and share images using **Cloudinary**.
15+
- πŸ—ƒοΈ **MongoDB Database**: Scalable and flexible **NoSQL** database for storing users and chat messages.
16+
- πŸ“± **Responsive UI**: Built with **React** and **Tailwind CSS** to work seamlessly across mobile, tablet, and desktop.
1617

1718
---
1819

19-
## Tech Stack
20+
## 🧰 Tech Stack
2021

21-
### Frontend
22-
- **React**: For building a dynamic and interactive user interface.
22+
### πŸ–₯️ Frontend
23+
- **React** – Component-based UI library for dynamic interfaces.
24+
- **Tailwind CSS** – Utility-first CSS framework for styling.
25+
- **Vite** – Fast frontend build tool and development server.
2326

24-
### Backend
25-
- **Node.js**: For managing the server-side logic and APIs.
27+
### βš™οΈ Backend
28+
- **Node.js** – JavaScript runtime for server-side logic.
29+
- **Express.js** – Minimalist web framework for building REST APIs.
2630

27-
### Database
28-
- **MongoDB**: A NoSQL database for efficient data storage and retrieval.
31+
### πŸ—„οΈ Database
32+
- **MongoDB** – Document-based NoSQL database for efficient data management.
2933

30-
### Authentication
31-
- **Firebase**: Provides secure and reliable user authentication.
34+
### πŸ” Authentication
35+
- **Firebase Auth** – Handles secure login, registration, and session management.
3236

33-
### Media Handling
34-
- **Cloudinary**: Handles image uploads and optimizations.
37+
### 🌐 Media Handling
38+
- **Cloudinary** – Cloud-based image and media upload, transformation, and CDN.
39+
40+
### πŸ” Encryption
41+
- **AES (Advanced Encryption Standard)** – Symmetric encryption algorithm for securing chat messages before storage/transmission.
3542

3643
---
3744

@@ -81,7 +88,7 @@ Follow these steps to get the application up and running on your local machine:
8188
---
8289

8390

84-
## Contributing
91+
## 🀝 Contributing
8592

8693
We welcome contributions to improve CommUnity! Follow these steps:
8794

@@ -91,7 +98,7 @@ We welcome contributions to improve CommUnity! Follow these steps:
9198
4. Push to the branch: `git push origin feature-name`.
9299
5. Open a pull request.
93100

94-
## Contact
101+
## πŸ“ž Contact
95102

96103
If you have any questions or feedback, feel free to reach out:
97104
- **Email**: pragyaxibs4834@gmail.com

0 commit comments

Comments
Β (0)