Add API contract guide, split spec template, finalize grading system
- New API-Contract-Guide.md: explains HTTP/API basics from scratch,
why backend and frontend need a contract, what backend must document
and when, what frontend needs and when, a worked endpoint example
from docs/examples/example_module, and a reconciliation checklist.
- Getting-Started.md: specification.md replaced with separate
specification-backend.md / specification-frontend.md per module
(chosen so contract mismatches are a real, checkable thing), links
to the new guide.
- Home.md: add API contract guide to the navigation list.
- Grading-System.md: fill in the full 100-point breakdown (15+10+20+10+35+10),
with defense in Module 3 serving as the exam, backend/frontend graded
separately except for the joint integration score.
Update for 14 teams (7 backend + 7 frontend), not 7
The repo now has a frontend/ folder alongside modules/ (one backend
team and one frontend team per module). Updated:
- Getting-Started.md: module table now lists both the backend and
frontend folder per module, Issue/team-file/spec instructions
distinguish backend vs frontend (team-backend.md / team-frontend.md,
a shared specification.md since the API contract is exactly what
both sides need to agree on), and the API-integration example section
now covers both docs/examples/example_module/ and frontend/_example/.
- Git-GitHub-Guide.md: branch naming now includes role
(<module>-backend/... / <module>-frontend/...), since a bare module
name no longer identifies which of the two teams a branch belongs to.
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).
Updated Getting Started (markdown)
moiaa
committed
Sep 11, 2026
Updated Начало работы (markdown)
moiaa
committed
Sep 11, 2026
Updated Getting Started (markdown)
moiaa
committed
Sep 11, 2026
Updated Getting Started (markdown)
moiaa
committed
Sep 11, 2026
Updated Начало работы (markdown)
moiaa
committed
Sep 11, 2026