You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -38,6 +44,8 @@ Until those runtimes exist, validate foundation changes with:
38
44
Get-ChildItem -Recurse -File
39
45
```
40
46
47
+
Do not fix Windows dependency installation failures by adding Visual Studio Build Tools or Rust requirements. If `pydantic-core`, `maturin`, or `link.exe` errors appear, recreate the venv with Python 3.12 and reinstall from wheels.
48
+
41
49
## Documentation Update Rules
42
50
43
51
- Update `tasks.md` whenever a roadmap item changes status.
Copy file name to clipboardExpand all lines: README.md
+64-5Lines changed: 64 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
College Exploration Platform is a full-stack decision-support product for helping prospective and admitted students discover, compare, rank, and justify college choices with transparent data and deterministic scoring.
4
4
5
-
Status: V1.3 FastAPI foundation complete. Search routes, frontend pages, ranking logic, Redis, pgvector, and deployment are intentionally not implemented yet.
5
+
Status: V1.4 structured search API complete. Frontend pages, ranking logic, Redis, pgvector, and deployment are intentionally not implemented yet.
6
6
7
7
## Project Thesis
8
8
@@ -37,13 +37,44 @@ Copy-Item .env.example .env
37
37
docker compose up -d postgres
38
38
```
39
39
40
-
Install backend tooling:
40
+
### Python Setup
41
+
42
+
Use Python `>=3.12,<3.13`. Python 3.12 is the supported local development version for this project. Do not use Python 3.14 yet; several native-extension dependencies may not have Windows wheels for it.
43
+
44
+
Verify your Python launcher can find Python 3.12:
41
45
42
46
```powershell
43
-
cd apps/api
44
-
python -m pip install -r requirements.txt
47
+
py -3.12 --version
48
+
```
49
+
50
+
### Virtual Environment Setup
51
+
52
+
Create and activate a local Python virtual environment from the project root:
53
+
54
+
```powershell
55
+
py -3.12 -m venv .venv
56
+
.\.venv\Scripts\activate
45
57
```
46
58
59
+
Confirm the venv is active and using Python 3.12:
60
+
61
+
```powershell
62
+
python --version
63
+
python -c "import sys; print(sys.prefix)"
64
+
```
65
+
66
+
`sys.prefix` should point at this repository's `.venv` directory.
If installation fails with `Failed building wheel for pydantic-core`, `maturin failed`, or `link.exe not found`, pip is trying to compile native code locally. That usually means the venv is using an unsupported or too-new Python version, or pip has cached an incompatible artifact.
Do not install Visual Studio Build Tools or Rust for this project just to satisfy dependency installation. The supported path is Python 3.12 plus prebuilt wheels.
137
+
82
138
## Roadmap Summary
83
139
84
140
- V1: Production-quality MVP with database schema, FastAPI foundation, structured search, school profiles, frontend foundation, onboarding, deterministic ranking, saved schools, comparison, Redis caching, and deployment polish.
@@ -92,6 +148,9 @@ See [tasks.md](tasks.md) for the working checklist.
92
148
Current backend validation commands are:
93
149
94
150
```powershell
151
+
py -3.12 --version
152
+
.\.venv\Scripts\activate
153
+
python --version
95
154
docker compose up -d postgres
96
155
cd apps/api
97
156
alembic upgrade head
@@ -107,7 +166,7 @@ Expected future commands:
107
166
108
167
## Limitations
109
168
110
-
-Only `/health` and `/ready` API endpoints exist. Search, profile, saved-school, comparison, and ranking endpoints are not implemented yet.
169
+
-`/health`, `/ready`, and `/schools/search` exist. Profile, saved-school, comparison, and ranking endpoints are not implemented yet.
111
170
- No UI pages, ranking engine, Redis cache, pgvector integration, or deployment exists yet.
112
171
- No performance metrics are available.
113
172
- Seed data is synthetic and intended for deterministic local development, not factual school reporting.
0 commit comments