|
3 | 3 |
|
4 | 4 | SecureComm is a **chat room–style communication platform** that enables users to exchange messages in real time, protected by strong end-to-end encryption. |
5 | 5 |
|
6 | | -It behaves like a traditional chat room in usage, but unlike conventional platforms, **the server cannot read, store, or decrypt messages**. All encryption and decryption occur exclusively on client devices. |
| 6 | +It behaves like a traditional chat room in everyday use. The crucial difference is architectural: **the server cannot read, store, or decrypt messages**. All encryption and decryption occur exclusively on client devices. |
7 | 7 |
|
8 | 8 | --- |
9 | 9 |
|
10 | 10 | ## What SecureComm Is |
11 | 11 |
|
12 | | -SecureComm works like a live chat room: |
| 12 | +SecureComm functions like a live chat room: |
13 | 13 |
|
14 | 14 | - Users join a shared communication space |
15 | 15 | - Messages appear instantly to all participants |
16 | 16 | - Conversations are real-time and interactive |
17 | 17 |
|
18 | | -The difference lies beneath the surface. |
| 18 | +The distinction lies beneath the surface. |
19 | 19 |
|
20 | 20 | > Messages are encrypted on your device before transmission and decrypted only on the recipient’s device. |
21 | | -> The server merely relays encrypted data and remains blind to message contents. |
| 21 | +> The server merely relays encrypted payloads and remains blind to message contents. |
22 | 22 |
|
23 | 23 | --- |
24 | 24 |
|
25 | 25 | ## Abstract |
26 | 26 |
|
27 | 27 | SecureComm is a secure communication platform designed for confidential, real-time messaging in a chat room environment. It employs an end-to-end encryption model to preserve message confidentiality, integrity, and authenticity against both external adversaries and the service operator itself. |
28 | 28 |
|
29 | | -The system follows a **zero-knowledge architecture**, where cryptographic keys are generated, stored, and used exclusively on client devices. Servers act only as untrusted relays and session coordinators. |
| 29 | +The system follows a **zero-knowledge architecture**, where cryptographic keys are generated, stored, and used exclusively on client devices. Servers act solely as untrusted relays and session coordinators. |
30 | 30 |
|
31 | 31 | --- |
32 | 32 |
|
33 | 33 | ## Problem Statement |
34 | 34 |
|
35 | | -Many modern chat platforms retain access to user data through server-side key storage, message logging, or excessive metadata retention. These practices introduce unnecessary trust assumptions and expand the attack surface. |
| 35 | +Many modern chat platforms retain access to user data through server-side key storage, message logging, or excessive metadata retention. These designs introduce unnecessary trust assumptions and significantly expand the attack surface. |
36 | 36 |
|
37 | 37 | SecureComm eliminates these risks by enforcing encryption at the client layer and treating the server as an untrusted intermediary. |
38 | 38 |
|
@@ -104,12 +104,75 @@ The server knows **that** messages are sent, not **what** they contain. |
104 | 104 |
|
105 | 105 | ## Installation |
106 | 106 |
|
107 | | -### Local Development Setup |
| 107 | +SecureComm supports multiple installation methods depending on your use case. |
108 | 108 |
|
109 | | -To run SecureComm locally: |
| 109 | +--- |
| 110 | + |
| 111 | +### Method 1: Local Development (Recommended) |
| 112 | + |
| 113 | +Best suited for contributors, testers, and developers. |
110 | 114 |
|
111 | 115 | ```bash |
112 | 116 | git clone https://github.com/pangerlkr/SecureComm.git |
113 | 117 | cd SecureComm |
114 | 118 | npm install |
115 | 119 | npm run dev |
| 120 | +``` |
| 121 | +The application starts in development mode with hot reloading enabled. |
| 122 | + |
| 123 | +--- |
| 124 | + |
| 125 | +### Method 2: Production Build (Node.js) |
| 126 | + |
| 127 | +Recommended for deploying SecureComm on a server or VPS. |
| 128 | + |
| 129 | +```bash |
| 130 | +git clone https://github.com/pangerlkr/SecureComm.git |
| 131 | +cd SecureComm |
| 132 | +npm install |
| 133 | +npm run build |
| 134 | +npm start |
| 135 | +``` |
| 136 | +This runs SecureComm in production mode with optimized assets. |
| 137 | + |
| 138 | +--- |
| 139 | + |
| 140 | +### Method 3: Docker Deployment |
| 141 | + |
| 142 | +Suitable for containerized and reproducible environments. |
| 143 | + |
| 144 | +```bash |
| 145 | +git clone https://github.com/pangerlkr/SecureComm.git |
| 146 | +cd SecureComm |
| 147 | +docker build -t securecomm . |
| 148 | +docker run -p 3000:3000 securecomm |
| 149 | +``` |
| 150 | +This method isolates dependencies and simplifies deployment. |
| 151 | + |
| 152 | +--- |
| 153 | +### Method 4: Using Docker Compose |
| 154 | + |
| 155 | +Recommended for structured deployments and future scalability. |
| 156 | + |
| 157 | +```bash |
| 158 | +git clone https://github.com/pangerlkr/SecureComm.git |
| 159 | +cd SecureComm |
| 160 | +docker-compose up --build |
| 161 | +``` |
| 162 | +Ensure Docker and Docker Compose are installed before using this method. |
| 163 | + |
| 164 | +--- |
| 165 | +### Method 5: Environment-Based Deployment (.env) |
| 166 | + |
| 167 | +For environments requiring configurable runtime variables. |
| 168 | + |
| 169 | +```bash |
| 170 | +git clone https://github.com/pangerlkr/SecureComm.git |
| 171 | +cd SecureComm |
| 172 | +cp .env.example .env |
| 173 | +npm install |
| 174 | +npm run build |
| 175 | +npm start |
| 176 | +``` |
| 177 | +Update .env with appropriate configuration values before starting the application. |
| 178 | + |
0 commit comments