Skip to content

Commit 1d30365

Browse files
committed
Add Docker as alternative quick start option
1 parent 6ef051e commit 1d30365

File tree

1 file changed

+24
-29
lines changed

1 file changed

+24
-29
lines changed

README.md

Lines changed: 24 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -169,60 +169,55 @@ Traditional encryption can be broken with enough computing power. **Quantum Key
169169

170170
### Prerequisites
171171

172-
```bash
173-
Node.js 18+ and npm/yarn/bun
174-
```
172+
Choose one of the following:
173+
- **Node.js 18+** with npm/yarn/bun
174+
- **Docker** (no Node.js required)
175175

176-
### Installation
176+
### Option 1: Using Node.js
177177

178178
```bash
179179
# Clone the repository
180180
git clone https://github.com/PRODHOSH/bb84_simulation.git
181-
182-
# Navigate to project
183181
cd bb84_simulation
184182

185183
# Install dependencies
186184
npm install
187-
# or
188-
yarn install
189-
# or
190-
bun install
191185

192186
# Start development server
193187
npm run dev
194-
# or
195-
yarn dev
196-
# or
197-
bun dev
198188
```
199189

200-
### Build for Production
190+
### Option 2: Using Docker 🐳
201191

202192
```bash
203-
npm run build
204-
npm run preview
205-
```
193+
# Clone the repository
194+
git clone https://github.com/PRODHOSH/bb84_simulation.git
195+
cd bb84_simulation
206196

207-
---
197+
# Build and run with Docker
198+
docker build -t bb84-simulation .
199+
docker run -p 3000:80 bb84-simulation
208200

209-
## 🐳 Docker Deployment
201+
# Access at http://localhost:3000
202+
```
210203

211-
### Quick Start with Docker
204+
### Build for Production
212205

213206
```bash
214-
# Build the Docker image
215-
docker build -t bb84-simulation .
216-
217-
# Run the container
218-
docker run -p 3000:80 bb84-simulation
207+
# Node.js
208+
npm run build
209+
npm run preview
219210

220-
# Access at http://localhost:3000
211+
# Or with Docker
212+
docker build -t bb84-simulation .
213+
docker run -d -p 3000:80 bb84-simulation
221214
```
222215

223-
### Docker Compose (Optional)
216+
---
217+
218+
## 🐳 Docker Compose (Optional)
224219

225-
Create a `docker-compose.yml`:
220+
For easier container management, create a `docker-compose.yml`:
226221

227222
```yaml
228223
version: '3.8'

0 commit comments

Comments
 (0)