You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+29-22Lines changed: 29 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,37 +1,44 @@
1
-
# CommUnity
1
+
# π¬ CommUnity
2
2
3
-
### A Real-Time Chat Application
3
+
### A Real-Time π Encrypted Chat Application
4
4
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.
6
6
7
7
---
8
8
9
-
## Features
9
+
## π Features
10
10
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.
16
17
17
18
---
18
19
19
-
## Tech Stack
20
+
## π§° Tech Stack
20
21
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.
23
26
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.
26
30
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.
29
33
30
-
### Authentication
31
-
-**Firebase**: Provides secure and reliable user authentication.
34
+
### π Authentication
35
+
-**Firebase Auth** β Handles secure login, registration, and session management.
32
36
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.
35
42
36
43
---
37
44
@@ -81,7 +88,7 @@ Follow these steps to get the application up and running on your local machine:
81
88
---
82
89
83
90
84
-
## Contributing
91
+
## π€ Contributing
85
92
86
93
We welcome contributions to improve CommUnity! Follow these steps:
87
94
@@ -91,7 +98,7 @@ We welcome contributions to improve CommUnity! Follow these steps:
91
98
4. Push to the branch: `git push origin feature-name`.
92
99
5. Open a pull request.
93
100
94
-
## Contact
101
+
## π Contact
95
102
96
103
If you have any questions or feedback, feel free to reach out:
0 commit comments