Fill in FAQ with real issues found while building/testing this repo
Replaced the placeholder with verified problems and fixes, not
hypothetical ones: the python-jose version pin that broke pip install,
the missing .env.example, the hyphenated module folders that broke
Python imports (all three already fixed on main — the FAQ entries
explain what an outdated local clone looks like and how to fix it),
the "no such table" error and its two real causes (forgot `init`, or a
new model's router isn't wired into core/api.py yet), the ambiguous
SQLAlchemy relationship error we actually hit in core/models.py (two
FKs to users.id) with the foreign_keys= fix, frontend 404s from a
missing index.html, CORS/fetch troubleshooting for the static-served
frontend, and the common Git/CI rejection scenarios.
Fix broken links, module paths, and add missing referenced pages
- Home.md: fixed repo name (was "College_Management_System2131",
actual repo is "College_Management_System").
- Getting-Started.md: fixed Issues link (same repo name mismatch),
fixed self-referencing broken link (was pointing to a dead
"Начало-работы" slug instead of Installation-Setup), updated module
folder paths to match the renamed modules/admin_panel,
modules/student_portal, modules/teacher_portal (underscores instead
of hyphens, since hyphens aren't valid in a Python import path).
Documented the new docs/examples/example_module/ reference pattern.
- Installation-Setup.md: replaced the placeholder clone URL
(your-org/college-management-system) with the real repo URL and
correct folder name, removed the mention of PyJWT as an installed
dependency (dropped as unused/redundant, see the main repo's latest
commits).
- Added Git-GitHub-Guide.md, Grading-System.md, FAQ.md as minimal
placeholder pages — both Getting Started and Installation Setup
already linked to these three pages, but they didn't exist yet.
Left as short placeholders (not full guides) since grading policy
and git workflow specifics are the instructor's call, not something
to fabricate.
- Added Tech-Spec-Design-Curriculum.md, Tech-Spec-Design-Reports.md,
Tech-Spec-Design-Teacher-portal.md, Tech-Spec-Design-Admin-panel.md,
matching the existing minimal one-line style of
Tech-Spec-Design-Gradebook/Schedule/Student-portal, so all 7 modules
have a page (still just placeholders for teams to fill in via their
own ТЗ, not pre-written specs).