Skip to content

Commit bbf6b04

Browse files
authored
Merge pull request #30 from Medha375/fix/Algorithm-Visualiser-Platform.git
Fix project name typo in README.md
2 parents 395124a + d73c0b9 commit bbf6b04

File tree

1 file changed

+24
-20
lines changed

1 file changed

+24
-20
lines changed

README.md

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<div align="center">
2-
<img src="image.png" alt="Algorithm Visualizer Pro Logo" width="200"/>
2+
<img src="image.png" alt="Algorithm Visualiser Pro Logo" width="200"/>
33

44
# 🎯 Algorithm Visualizer Pro
55

@@ -39,7 +39,7 @@
3939

4040
## 🌟 Overview
4141

42-
**Algorithm Visualizer Pro** is a cutting-edge educational platform that transforms abstract algorithmic concepts into engaging, interactive visual experiences. Built with modern web technologies, it serves as a comprehensive learning tool for students, educators, and algorithm enthusiasts worldwide.
42+
**Algorithm Visualiser Pro** is a cutting-edge educational platform that transforms abstract algorithmic concepts into engaging, interactive visual experiences. Built with modern web technologies, it serves as a comprehensive learning tool for students, educators, and algorithm enthusiasts worldwide.
4343

4444
### 🎯 Mission
4545
To bridge the gap between theoretical computer science and practical understanding by providing intuitive, step-by-step algorithm visualizations that make complex concepts accessible to learners at all levels.
@@ -128,7 +128,7 @@ To bridge the gap between theoretical computer science and practical understandi
128128
<table>
129129
<tr>
130130
<th>🆚 Feature</th>
131-
<th>✅ Algorithm Visualizer Pro</th>
131+
<th>✅ Algorithm Visualiser Pro</th>
132132
<th>❌ Traditional Learning</th>
133133
</tr>
134134
<tr>
@@ -188,15 +188,19 @@ To bridge the gap between theoretical computer science and practical understandi
188188
Get up and running in under 5 minutes!
189189

190190
```bash
191-
# 1️⃣ Clone the repository
192-
git clone https://github.com/CipherYuvraj/Algorithm-Visualizer-Platform.git
193-
cd Algorithm-Visualizer-Platform
194191

195-
# 2️⃣ Install dependencies
192+
# 1️⃣ Fork the repository
193+
194+
# 2️⃣ Clone the repository
195+
git clone https://github.com/<your-username>/Algorithm-Visualiser-Platform.git
196+
cd Algorithm-Visualiser-Platform
197+
198+
# 3️⃣ Install dependencies
196199
npm install
197200
cd backend && pip install -r requirements.txt
201+
cd backend && pip install -r requirements.txt
198202

199-
# 3️⃣ Start development servers
203+
# 4️⃣ Start development servers
200204
npm run dev # Frontend (http://localhost:3000)
201205
npm run dev:api # Backend (http://localhost:8000)
202206

@@ -220,7 +224,7 @@ npm run dev:api # Backend (http://localhost:8000)
220224

221225
```bash
222226
# Navigate to project root
223-
cd Algorithm-Visualizer-Platform/frontend
227+
cd Algorithm-Visualiser-Platform/frontend
224228

225229
# Install dependencies
226230
npm install
@@ -236,7 +240,7 @@ npm run lint:fix # Fix ESLint issues
236240
**Environment Variables** (`.env`):
237241
```env
238242
VITE_API_BASE_URL=http://localhost:8000
239-
VITE_APP_TITLE="Algorithm Visualizer Pro"
243+
VITE_APP_TITLE="Algorithm Visualiser Pro"
240244
VITE_ENABLE_ANALYTICS=false
241245
```
242246

@@ -247,7 +251,7 @@ VITE_ENABLE_ANALYTICS=false
247251

248252
```bash
249253
# Navigate to backend directory
250-
cd Algorithm-Visualizer-Platform/backend
254+
cd Algorithm-Visualiser-Platform/backend
251255

252256
# Create virtual environment
253257
python -m venv venv
@@ -346,11 +350,11 @@ CMD ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "8000"]
346350

347351
```bash
348352
# Build and push images
349-
docker build -t yourusername/algo-visualizer-frontend ./frontend
350-
docker build -t yourusername/algo-visualizer-backend ./backend
353+
docker build -t yourusername/algo-visualiser-frontend ./frontend
354+
docker build -t yourusername/algo-visualiser-backend ./backend
351355

352-
docker push yourusername/algo-visualizer-frontend
353-
docker push yourusername/algo-visualizer-backend
356+
docker push yourusername/algo-visualiser-frontend
357+
docker push yourusername/algo-visualiser-backend
354358
```
355359

356360
### ☁️ Cloud Platforms
@@ -363,9 +367,9 @@ docker push yourusername/algo-visualizer-backend
363367
# Build and tag for ECR
364368
aws ecr get-login-password --region us-east-1 | docker login --username AWS --password-stdin your-account.dkr.ecr.us-east-1.amazonaws.com
365369

366-
docker build -t algo-visualizer .
367-
docker tag algo-visualizer:latest your-account.dkr.ecr.us-east-1.amazonaws.com/algo-visualizer:latest
368-
docker push your-account.dkr.ecr.us-east-1.amazonaws.com/algo-visualizer:latest
370+
docker build -t algo-visualiser .
371+
docker tag algo-visualiser:latest your-account.dkr.ecr.us-east-1.amazonaws.com/algo-visualiser:latest
372+
docker push your-account.dkr.ecr.us-east-1.amazonaws.com/algo-visualiser:latest
369373
```
370374

371375
</details>
@@ -376,8 +380,8 @@ docker push your-account.dkr.ecr.us-east-1.amazonaws.com/algo-visualizer:latest
376380
**Using Cloud Run:**
377381
```bash
378382
# Build and deploy
379-
gcloud builds submit --tag gcr.io/PROJECT-ID/algo-visualizer
380-
gcloud run deploy --image gcr.io/PROJECT-ID/algo-visualizer --platform managed
383+
gcloud builds submit --tag gcr.io/PROJECT-ID/algo-visualiser
384+
gcloud run deploy --image gcr.io/PROJECT-ID/algo-visualiser --platform managed
381385
```
382386

383387
</details>

0 commit comments

Comments
 (0)