Updated Tech Spec Design Gradebook (markdown)
bd65f2a
Updated Tech Spec Design Gradebook (markdown)
32211b9
Updated Tech Spec Design Gradebook (markdown)
74c3e27
Updated Tech Spec Design Gradebook (markdown)
93ca250
Updated Tech Spec Design Gradebook (markdown)
28cf6df
Updated Tech Spec Design Gradebook (markdown)
0af3f38
Updated Tech Spec Design Gradebook (markdown)
bf786ea
Updated Tech Spec Backend Student portal (markdown)
185a98f
Updated Tech Spec Backend Student portal (markdown)
cdb43ed
Add ТЗ structure/template to all 14 Tech Spec pages (backend + design)
Each page now has the section skeleton to fill in (purpose, functional
requirements, API endpoints, DB structure or screens/wireframes,
acceptance criteria) instead of just a title stub. Sections in
brackets are prompts, not content - teams still write everything
specific to their own module themselves. Backend and Design templates
differ (DB/API focus vs screens/API-consumer focus) and both point to
the API Contract Guide for the shared 4.1 section.
62b9f35
Improve Installation Setup: verify the app actually runs end-to-end, fix structure diagram
- Add a step to actually start the server and check both /health and
the working frontend example, not just pytest/flake8 - catches
problems before students build a module on top of a broken setup.
- Replace the stale, incomplete project-structure listing with one
that matches the repo as it exists now (frontend/, docs/examples,
.github/workflows, .flake8, .env.example, .gitignore) and fix the
venv/.venv naming inconsistency.
- Point python-jose/.env.example/hyphenated-folder errors at FAQ
instead of duplicating them here.
6191a04
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.
380c8d3
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.
ef2ffb8
Rewrite Home as a real landing/navigation page
Home.md was a single welcome line. Rewrote it as the actual entry
point: what the project is (one app, Python/FastAPI backend + plain
HTML/CSS/JS frontend, one DB, 7 modules), how the 14 teams are split
(backend + frontend per module), a step-by-step "how to work with
this" pointing at Getting Started -> Installation Setup ->
Git-GitHub-Guide -> Grading System -> FAQ in the order you'd actually
need them, links to the real architecture doc and the working example
(docs/examples/example_module + frontend/_example) in the repo, and a
full table linking every module's Design and Backend Tech Spec pages.
Also renamed Tech-Spec-Design-Student‐portal.md (used a U+2010 hyphen)
to Tech-Spec-Design-Student-portal.md, matching the plain hyphen used
by all 13 other Tech Spec pages — needed a consistent, guessable name
to link to from the new table.
70b3c42
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.
7327b24
Write the full Git/GitHub workflow guide
Replaced the two-paragraph placeholder with a complete guide covering
the actual working model for this repo (7 teams, one repo, no forks,
branch-per-task with a module prefix), the full task cycle (sync main,
branch, commit style, push, open PR referencing the module's CI checks,
review, merge), how to bring a branch up to date with main and resolve
conflicts, a do/don't list (no direct pushes to main, no force-push on
shared branches, don't commit what .gitignore already covers), and a
command cheat sheet.
23c31f1
Add backend/technical Tech Spec pages for each module
Getting Started already asked teams to write a full ТЗ (specification.md)
covering functional/non-functional requirements, API endpoints and DB
schema, but the only per-module wiki pages that existed were the
"Tech Spec Design" ones (UI/design side). Added a parallel
"Tech-Spec-Backend-<Module>" placeholder page for each of the 7 modules,
matching the same minimal one-line style as the existing Design pages
(a title, not pre-written content) — the backend team fills it in via
their own ТЗ, same as with the design pages.
ca84877
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).
bdb7d0f
Created Tech Spec Design Student-portal (markdown)
moiaa
committed
Sep 12, 2026
99e3c03
Created Tech Spec Design Schedule (markdown)
moiaa
committed
Sep 12, 2026
722a5ea
Created Tech Spec Design Gradebook (markdown)
moiaa
committed
Sep 12, 2026
a470eff
Updated Getting Started (markdown)
moiaa
committed
Sep 11, 2026
899b147
Updated Начало работы (markdown)
moiaa
committed
Sep 11, 2026
0196766
Updated Getting Started (markdown)
moiaa
committed
Sep 11, 2026
ec4b7d3
Updated Getting Started (markdown)
moiaa
committed
Sep 11, 2026
2b8b5d2
Updated Начало работы (markdown)
moiaa
committed
Sep 11, 2026
179775d
create Installation Setup
moiaa
committed
Sep 11, 2026
a163d23