# Masar / مسار — Project starting point

Masar is an Arabic, right-to-left educational counseling platform. The supplied HTML prototype is the visual reference for the project.

## Read in this order

1. [Stage 1 foundation](STAGE_1_FOUNDATION.md): delivered structure, local setup, main changes, and verification.
2. [Project instructions](PROJECT_INSTRUCTIONS.md): implementation rules and the required central theme configuration.
3. [Design reference](DESIGN_REFERENCE.md): colors, fonts, dimensions, and component styling extracted from the prototype.
4. [Responsive requirements](RESPONSIVE_REQUIREMENTS.md): required behavior across phones, tablets, and desktops.
5. [Backend instructions](BACKEND_INSTRUCTIONS.md): MySQL setup, clean code structure, efficient queries, reliable saves, and scaling requirements.
6. [Stage 2 management](STAGE_2_MANAGEMENT.md): users, fixed user types, school fields, assignments, implementation defaults, and local verification.
7. [Counselor forms inventory](COUNSELOR_FORMS.md): prototype registers, case-study fields, save/review behavior, and decisions for later implementation.

8. [Deployment instructions](DEPLOYMENT.md): maintained install/update procedures, hosting routes, migrations, seeders, backups and release checks.

## Reference and scope

- Source: [original HTML prototype](<../مسار%20_%20منصة%20الإرشاد%20التربوي%20(نسخة%20تجريبية).html>).
- Extraction date: 2026-10-21.
- The prototype contains counselor and supervisor interfaces, counseling registers, case studies, review actions, statistics, and printing.
- Its data and role switching are demonstrations. State is stored in browser local storage; these features do not establish a production backend or access-control design.
- The source defines seven ordinary register types in `REGS`, plus case studies separately. The login describes eight registers; preserve this distinction when planning the data model.

Stage 1 now includes the React frontend, Laravel API, and integrated root `style-theme.config.json`. The original HTML remains unchanged. See the stage record for implemented scope and checks; the full prototype workflows are planned for later stages.

## Required direction

Preserve the prototype's Arabic typography, green identity, restrained surfaces, and recognizable components. Implement responsive layouts as a project requirement. Put shared visual settings in one root-level file named `style-theme.config.json`, with light and dark palettes and responsive settings controlled from that file.

Arabic and English support is mandatory across the React frontend and Laravel backend interface. Arabic is the default; English uses an LTR layout. See [the language requirements](PROJECT_INSTRUCTIONS.md#arabic-and-english-support) for translations, language switching, persistence, and acceptance rules. The Stage 2 backend implements both languages; the React frontend's bilingual implementation remains pending.
