Talal Sharabi 5980451ea8 feat: integrate client requirements (courseware, communication, notifications, FAQ, enhanced approvals)
Add 4 new Odoo modules coverage:
- encoach_courseware: chapters, materials, chapter progress, AI workbench
- encoach_communication: discussion boards, announcements, messaging
- encoach_notification: notification engine, rules, preferences
- encoach_faq: FAQ categories and items, role-filtered

Frontend changes:
- 4 new type files (courseware, communication, notification, faq)
- 5 new service files (courseware, communication, notification, faq, plagiarism)
- 4 new hook files (useCourseware, useCommunication, useNotifications, useFaq)
- 15 new page components (teacher: chapters, chapter detail, AI workbench,
  discussions, announcements; student: chapter view, discussions, announcements,
  messages, journey; admin: FAQ manager, notification rules, approval config;
  public: official exam access, FAQ page)
- Updated App.tsx routing with all new pages
- Updated TeacherLayout, StudentLayout, AdminLmsLayout sidebars

SRS updates:
- ENCOACH_UNIFIED_SRS.md: added Parts IX-XI (Courseware, Communication,
  Notifications/FAQ), enhanced exam management (exercise vs exam, official
  access modes), enhanced approval workflows (timed stages, escalation,
  bypass), enhanced assignments (late submissions, extensions), plagiarism
  detection. Total modules: 35
- ENCOACH_ODOO19_BACKEND_SRS.md v2.0: added sections 26-31, updated module
  inventory to 35, updated endpoint count to 280+, added enhanced assignment
  models with late submission/extension support

Made-with: Cursor
2026-03-27 00:20:30 +04:00

EnCoach — Adaptive Learning Platform (Frontend)

The frontend application for the EnCoach Adaptive Learning Platform, serving UTAS university students and freelance learners across IELTS, Mathematics, and IT courses.

Built with React 18, TypeScript, and Vite. Connects to an Odoo 19 backend via REST API.

Tech Stack

Layer Technology
Framework React 18 + TypeScript
Build Vite 5 (SWC)
Routing React Router v6
State / Data TanStack Query v5, React Context
UI Components shadcn/ui + Radix UI
Styling Tailwind CSS 3
Forms react-hook-form + Zod validation
Charts Recharts
Icons Lucide React

Architecture

src/
├── components/         # Shared UI, layouts, AI components
│   ├── ai/             # 14 AI-powered components (coaching, grading, insights)
│   └── ui/             # shadcn/ui primitives
├── contexts/           # AuthContext (JWT session management)
├── hooks/
│   ├── queries/        # TanStack Query hooks (exams, assignments, LMS, adaptive)
│   └── usePermissions  # Entity-scoped permission checks
├── lib/
│   ├── api-client.ts   # Centralized HTTP client with JWT + 401 interception
│   └── query-client.ts # TanStack Query configuration
├── pages/
│   ├── admin/          # Admin & LMS management (courses, batches, taxonomy, resources)
│   ├── student/        # Student portal (dashboard, courses, adaptive learning flow)
│   └── teacher/        # Teacher portal (courses, assignments, attendance, grading)
├── services/           # 21 API service modules mapped to Odoo endpoints
└── types/              # 14 TypeScript type definition files

Key Features

  • 7 User Roles — Student, Teacher, Admin, Corporate, Master Corporate, Agent, Developer
  • Adaptive Learning Engine — Diagnostic assessment, proficiency profiling, AI-generated learning plans, topic-level content delivery
  • LMS Integration — Course management, batches, timetables, attendance, grades (OpenEduCat via API)
  • Exam Portal — IELTS-style exams with AI grading, writing evaluation, speaking assessment
  • 14 AI Components — Study coach, writing helper, grading assistant, risk detection, insights panel, batch optimizer, report narratives
  • Entity-Scoped Permissions — Fine-grained access control with 77+ permission types
  • Multi-Subject Support — IELTS (English), Mathematics, IT — all using a universal subject taxonomy

Getting Started

Prerequisites

  • Node.js 18+ (or Bun)
  • Odoo 19 backend running (see docs/ODOO_BACKEND_SRS_v3.md)

Setup

# Clone the repository
git clone https://git.albousalh.com/devops/encoach_frontend_new_v1.git
cd encoach_frontend_new_v1

# Install dependencies
npm install

# Configure environment
cp .env.example .env.development

# Start development server
npm run dev

The app runs on http://localhost:8080 by default.

Environment Variables

Variable Description Default
VITE_API_BASE_URL Odoo backend API base URL http://localhost:8069/api
VITE_APP_NAME Application display name EnCoach

Scripts

Command Description
npm run dev Start dev server with HMR
npm run build Production build
npm run build:dev Development build
npm run preview Preview production build
npm run lint Run ESLint
npm run test Run tests
npm run test:watch Run tests in watch mode

Documentation

All project documentation is in the docs/ folder:

Document Purpose
ENCOACH_UNIFIED_SRS.md Master Software Requirements Specification
ODOO_BACKEND_SRS_v3.md Backend developer handoff (Odoo modules + API contract)
ENCOACH_PRODUCT_DESCRIPTION.md Non-technical product overview
UTAS_MASTER_PLAN.md Project timeline and milestones
MATH_IT_ADAPTIVE_LEARNING_SRS.md Adaptive learning engine specification

Backend API

The frontend expects an Odoo 19 backend exposing REST endpoints under /api/. All service modules in src/services/ map directly to the API contract defined in docs/ODOO_BACKEND_SRS_v3.md.

Authentication uses JWT tokens stored in localStorage, with automatic 401 interception and redirect to login.

License

Proprietary — EnCoach Platform. All rights reserved.

Description
No description provided
Readme 706 KiB
Languages
TypeScript 99.4%
CSS 0.4%
HTML 0.1%