Skip to content

Commit 85ef0b9

Browse files
Soumya KesharwaniSoumya Kesharwani
Soumya Kesharwani
authored and
Soumya Kesharwani
committed
# Conflicts: # static/style.css # utils/recommender.py
2 parents acfc470 + 0415f08 commit 85ef0b9

20 files changed

Lines changed: 3885 additions & 1622 deletions

‎.gitignore‎

Lines changed: 122 additions & 122 deletions
Original file line numberDiff line numberDiff line change
@@ -1,122 +1,122 @@
1-
# Miscellaneous
2-
*.class
3-
*.lock
4-
*.log
5-
*.pyc
6-
*.swp
7-
.buildlog/
8-
.history
9-
10-
11-
12-
# Flutter repo-specific
13-
/bin/cache/
14-
/bin/internal/bootstrap.bat
15-
/bin/internal/bootstrap.sh
16-
/bin/mingit/
17-
/dev/benchmarks/mega_gallery/
18-
/dev/bots/.recipe_deps
19-
/dev/bots/android_tools/
20-
/dev/devicelab/ABresults*.json
21-
/dev/docs/doc/
22-
/dev/docs/flutter.docs.zip
23-
/dev/docs/lib/
24-
/dev/docs/pubspec.yaml
25-
/dev/integration_tests/**/xcuserdata
26-
/dev/integration_tests/**/Pods
27-
/packages/flutter/coverage/
28-
version
29-
analysis_benchmark.json
30-
31-
# packages file containing multi-root paths
32-
.packages.generated
33-
34-
# Flutter/Dart/Pub related
35-
**/doc/api/
36-
.dart_tool/
37-
.flutter-plugins
38-
.flutter-plugins-dependencies
39-
**/generated_plugin_registrant.dart
40-
.packages
41-
.pub-preload-cache/
42-
.pub/
43-
build/
44-
flutter_*.png
45-
linked_*.ds
46-
unlinked.ds
47-
unlinked_spec.ds
48-
49-
# Android related
50-
**/android/**/gradle-wrapper.jar
51-
.gradle/
52-
**/android/captures/
53-
**/android/gradlew
54-
**/android/gradlew.bat
55-
**/android/local.properties
56-
**/android/**/GeneratedPluginRegistrant.java
57-
**/android/key.properties
58-
*.jks
59-
60-
# iOS/XCode related
61-
**/ios/**/*.mode1v3
62-
**/ios/**/*.mode2v3
63-
**/ios/**/*.moved-aside
64-
**/ios/**/*.pbxuser
65-
**/ios/**/*.perspectivev3
66-
**/ios/**/*sync/
67-
**/ios/**/.sconsign.dblite
68-
**/ios/**/.tags*
69-
**/ios/**/.vagrant/
70-
**/ios/**/DerivedData/
71-
**/ios/**/Icon?
72-
**/ios/**/Pods/
73-
**/ios/**/.symlinks/
74-
**/ios/**/profile
75-
**/ios/**/xcuserdata
76-
**/ios/.generated/
77-
**/ios/Flutter/.last_build_id
78-
**/ios/Flutter/App.framework
79-
**/ios/Flutter/Flutter.framework
80-
**/ios/Flutter/Flutter.podspec
81-
**/ios/Flutter/Generated.xcconfig
82-
**/ios/Flutter/ephemeral
83-
**/ios/Flutter/app.flx
84-
**/ios/Flutter/app.zip
85-
**/ios/Flutter/flutter_assets/
86-
**/ios/Flutter/flutter_export_environment.sh
87-
**/ios/ServiceDefinitions.json
88-
**/ios/Runner/GeneratedPluginRegistrant.*
89-
90-
# macOS
91-
**/Flutter/ephemeral/
92-
**/Pods/
93-
**/macos/Flutter/GeneratedPluginRegistrant.swift
94-
**/macos/Flutter/ephemeral
95-
**/xcuserdata/
96-
97-
# Windows
98-
**/windows/flutter/generated_plugin_registrant.cc
99-
**/windows/flutter/generated_plugin_registrant.h
100-
**/windows/flutter/generated_plugins.cmake
101-
102-
# Linux
103-
**/linux/flutter/generated_plugin_registrant.cc
104-
**/linux/flutter/generated_plugin_registrant.h
105-
**/linux/flutter/generated_plugins.cmake
106-
107-
# Coverage
108-
coverage/
109-
110-
# Symbols
111-
app.*.symbols
112-
113-
# Exceptions to above rules.
114-
!**/ios/**/default.mode1v3
115-
!**/ios/**/default.mode2v3
116-
!**/ios/**/default.pbxuser
117-
!**/ios/**/default.perspectivev3
118-
!/packages/flutter_tools/test/data/dart_dependencies_test/**/.packages
119-
!/dev/ci/**/Gemfile.lock.venv/
120-
# Python virtual environment
121-
venv/
122-
.venv/
1+
# Miscellaneous
2+
*.class
3+
*.lock
4+
*.log
5+
*.pyc
6+
*.swp
7+
.buildlog/
8+
.history
9+
10+
11+
12+
# Flutter repo-specific
13+
/bin/cache/
14+
/bin/internal/bootstrap.bat
15+
/bin/internal/bootstrap.sh
16+
/bin/mingit/
17+
/dev/benchmarks/mega_gallery/
18+
/dev/bots/.recipe_deps
19+
/dev/bots/android_tools/
20+
/dev/devicelab/ABresults*.json
21+
/dev/docs/doc/
22+
/dev/docs/flutter.docs.zip
23+
/dev/docs/lib/
24+
/dev/docs/pubspec.yaml
25+
/dev/integration_tests/**/xcuserdata
26+
/dev/integration_tests/**/Pods
27+
/packages/flutter/coverage/
28+
version
29+
analysis_benchmark.json
30+
31+
# packages file containing multi-root paths
32+
.packages.generated
33+
34+
# Flutter/Dart/Pub related
35+
**/doc/api/
36+
.dart_tool/
37+
.flutter-plugins
38+
.flutter-plugins-dependencies
39+
**/generated_plugin_registrant.dart
40+
.packages
41+
.pub-preload-cache/
42+
.pub/
43+
build/
44+
flutter_*.png
45+
linked_*.ds
46+
unlinked.ds
47+
unlinked_spec.ds
48+
49+
# Android related
50+
**/android/**/gradle-wrapper.jar
51+
.gradle/
52+
**/android/captures/
53+
**/android/gradlew
54+
**/android/gradlew.bat
55+
**/android/local.properties
56+
**/android/**/GeneratedPluginRegistrant.java
57+
**/android/key.properties
58+
*.jks
59+
60+
# iOS/XCode related
61+
**/ios/**/*.mode1v3
62+
**/ios/**/*.mode2v3
63+
**/ios/**/*.moved-aside
64+
**/ios/**/*.pbxuser
65+
**/ios/**/*.perspectivev3
66+
**/ios/**/*sync/
67+
**/ios/**/.sconsign.dblite
68+
**/ios/**/.tags*
69+
**/ios/**/.vagrant/
70+
**/ios/**/DerivedData/
71+
**/ios/**/Icon?
72+
**/ios/**/Pods/
73+
**/ios/**/.symlinks/
74+
**/ios/**/profile
75+
**/ios/**/xcuserdata
76+
**/ios/.generated/
77+
**/ios/Flutter/.last_build_id
78+
**/ios/Flutter/App.framework
79+
**/ios/Flutter/Flutter.framework
80+
**/ios/Flutter/Flutter.podspec
81+
**/ios/Flutter/Generated.xcconfig
82+
**/ios/Flutter/ephemeral
83+
**/ios/Flutter/app.flx
84+
**/ios/Flutter/app.zip
85+
**/ios/Flutter/flutter_assets/
86+
**/ios/Flutter/flutter_export_environment.sh
87+
**/ios/ServiceDefinitions.json
88+
**/ios/Runner/GeneratedPluginRegistrant.*
89+
90+
# macOS
91+
**/Flutter/ephemeral/
92+
**/Pods/
93+
**/macos/Flutter/GeneratedPluginRegistrant.swift
94+
**/macos/Flutter/ephemeral
95+
**/xcuserdata/
96+
97+
# Windows
98+
**/windows/flutter/generated_plugin_registrant.cc
99+
**/windows/flutter/generated_plugin_registrant.h
100+
**/windows/flutter/generated_plugins.cmake
101+
102+
# Linux
103+
**/linux/flutter/generated_plugin_registrant.cc
104+
**/linux/flutter/generated_plugin_registrant.h
105+
**/linux/flutter/generated_plugins.cmake
106+
107+
# Coverage
108+
coverage/
109+
110+
# Symbols
111+
app.*.symbols
112+
113+
# Exceptions to above rules.
114+
!**/ios/**/default.mode1v3
115+
!**/ios/**/default.mode2v3
116+
!**/ios/**/default.pbxuser
117+
!**/ios/**/default.perspectivev3
118+
!/packages/flutter_tools/test/data/dart_dependencies_test/**/.packages
119+
!/dev/ci/**/Gemfile.lock.venv/
120+
# Python virtual environment
121+
venv/
122+
.venv/

‎README.md‎

Lines changed: 85 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -145,64 +145,127 @@ E --> H[Learning Resources]
145145

146146
## Quick Start
147147

148+
### Linux/macOS Setup
149+
148150
```bash
149151
git clone https://github.com/komalharshita/devpath.git
150152
cd devpath
153+
154+
python3 -m venv venv
155+
source venv/bin/activate
156+
157+
pip install -r requirements.txt
158+
159+
python app.py
160+
```
161+
162+
### Windows Setup
163+
164+
```powershell
165+
git clone https://github.com/komalharshita/devpath.git
166+
cd devpath
167+
151168
python -m venv venv
152-
source venv/bin/activate # Windows: venv\Scripts\activate
169+
venv\Scripts\activate
170+
171+
pip install -r requirements.txt
172+
173+
python app.py
174+
```
153175

154-
# Shortcuts using the Makefile
155-
make install # Installs dependencies
156-
make run # Starts the development server
176+
## Verify Everything Works
177+
178+
Run the test suite:
179+
180+
```bash
181+
python tests/test_basic.py
182+
```
183+
184+
Expected output:
185+
186+
```bash
187+
All tests passed
157188
```
158189

159190
---
160191

161192
## Troubleshooting
162193

163-
### Common Setup Issues
194+
<details>
195+
<summary>Virtual Environment Issues</summary>
164196

165-
#### Virtual environment activation not working on Windows
197+
### Linux/macOS
166198

167-
Use:
199+
If activation fails, verify Python 3 is installed:
168200

169201
```bash
202+
python3 --version
203+
```
204+
205+
### Windows PowerShell
206+
207+
If you see:
208+
209+
```powershell
210+
running scripts is disabled on this system
211+
```
212+
213+
Run:
214+
215+
```powershell
216+
Set-ExecutionPolicy -Scope Process RemoteSigned
217+
```
218+
219+
Then activate the environment again:
220+
221+
```powershell
170222
venv\Scripts\activate
171223
```
172224

173-
instead of:
225+
</details>
226+
227+
<details>
228+
<summary>Dependency & Flask Issues</summary>
229+
230+
If dependency installation fails, first upgrade pip:
174231

175232
```bash
176-
source venv/bin/activate
233+
python -m pip install --upgrade pip
177234
```
178235

179-
#### ModuleNotFoundError
180-
181-
Make sure all dependencies are installed:
236+
Ensure Python 3.9+ is installed:
182237

183238
```bash
184-
pip install -r requirements.txt
239+
python --version
185240
```
186241

187-
#### Flask app not starting
242+
Reinstall requirements without cache:
243+
244+
```bash
245+
pip install -r requirements.txt --no-cache-dir
246+
```
188247

189-
Verify that you are running:
248+
If Flask is still missing:
190249

191250
```bash
192-
python app.py
251+
pip install flask
193252
```
194253

195-
from the project root directory.
196-
---
254+
</details>
197255

198-
**http://127.0.0.1:5000** — that is the entire setup.
256+
<details>
257+
<summary>Port Already in Use</summary>
258+
259+
If port 5000 is already in use, run the app on another port:
199260

200261
```bash
201-
# Verify everything works using the Makefile shortcut
202-
make test
203-
# 29 passed, 0 failed out of 29 tests
262+
flask run --port 5001
204263
```
205264

265+
Or stop the process currently using port 5000.
266+
267+
</details>
268+
206269
---
207270

208271
## Project Structure

0 commit comments

Comments
 (0)