Skip to content

Commit 826b8cf

Browse files
authored
Merge pull request #41 from SujalTripathi/docs/update-readme
docs: Update and correct project setup instructions
2 parents 72a0fcb + 2e2a813 commit 826b8cf

1 file changed

Lines changed: 29 additions & 13 deletions

File tree

README.md

Lines changed: 29 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ To bridge the gap between theoretical computer science and practical understandi
9696
| Technology | Version | Purpose |
9797
|------------|---------|---------|
9898
| **React** | 18.2.0 | Core UI framework with hooks and context |
99-
| **Vite** | 5.0.0 | Lightning-fast build tool and dev server |
99+
| **Create React App** | 5.0.1 | Build tool and development server |
100100
| **TailwindCSS** | 3.3.0 | Utility-first styling framework |
101101
| **Lucide React** | 0.294.0 | Beautiful icon library |
102102
| **Framer Motion** | 10.16.0 | Smooth animations and transitions |
@@ -185,24 +185,40 @@ To bridge the gap between theoretical computer science and practical understandi
185185

186186
## 🚀 Quick Start
187187

188-
Get up and running in under 5 minutes!
188+
Get up and running with these steps.
189189

190190
```bash
191-
192-
# 1️⃣ Fork the repository
193-
194-
# 2️⃣ Clone the repository
191+
# 1. Fork and Clone the repository
195192
git clone https://github.com/<your-username>/Algorithm-Visualiser-Platform.git
196193
cd Algorithm-Visualiser-Platform
197194

198-
# 3️⃣ Install dependencies
195+
# 2. Install Frontend Dependencies
196+
# (This command installs for the entire monorepo, including the frontend)
199197
npm install
200-
cd backend && pip install -r requirements.txt
201-
cd backend && pip install -r requirements.txt
202198

203-
# 4️⃣ Start development servers
204-
npm run dev # Frontend (http://localhost:3000)
205-
npm run dev:api # Backend (http://localhost:8000)
199+
# 3. Setup and Install Backend Dependencies
200+
# Create a virtual environment with Python 3.11
201+
py -3.11 -m venv venv
202+
203+
# Activate the virtual environment
204+
.\venv\Scripts\Activate.ps1
205+
# On macOS/Linux, use: source venv/bin/activate
206+
207+
# Install Python packages
208+
cd backend
209+
pip install -r requirements.txt
210+
cd ..
211+
212+
# 4. Run the Development Servers (in two separate terminals)
213+
214+
# In your FIRST terminal, run the backend:
215+
# (Make sure your venv is active)
216+
cd backend
217+
uvicorn main:app --reload
218+
219+
# In your SECOND terminal, run the frontend:
220+
cd frontend
221+
npm start
206222

207223
# 🎉 Open your browser and start exploring!
208224
```
@@ -214,7 +230,7 @@ npm run dev:api # Backend (http://localhost:8000)
214230
### 📋 Prerequisites
215231

216232
- **Node.js** 18.0+ ([Download](https://nodejs.org/))
217-
- **Python** 3.11+ ([Download](https://python.org/))
233+
- **Python** 3.11.x ([Download](https://www.python.org/downloads/release/python-3119/)) - *Note: Versions 3.12 and newer are not compatible with the project's dependencies.*
218234
- **Git** ([Download](https://git-scm.com/))
219235

220236
### 🔧 Detailed Setup

0 commit comments

Comments
 (0)