Documentation

Smart Arabic Speech Therapy Platform Documentation

A technical reference for architecture, services, and data flow.

Back to Home

Overview

Overview

Quick summary of the platform structure and main data flow.

Overview

The platform has three main layers: a Next.js frontend, a Node.js/Express backend for sessions and data management, and a Python AI service for audio processing and speech evaluation. The frontend talks to the API, while the backend integrates with the AI service to return assessment results.

Frontend

Next.js + Tailwind

Backend

Node/Express + Mongo

AI Service

Python + Speech

Testing & Running

Run each service from its own folder. The commands below are the minimum required to start the system locally.

Frontend

  • Install: npm install
  • Run: npm run dev
  • Tests: npm run test:e2e

Backend

  • Install: npm install
  • Run: npm run dev
  • Tests: npm test

AI Service

  • Install: pip install -r requirements.txt
  • Run: python ai-service\start.py
  • Health check: GET /health

Color Palette

The platform uses a consistent color system defined in Tailwind configuration. All colors support both light and dark modes.

Primary Colors

#27f138

primary

#1eb82b

primary-dark

#FF9F1C

accent-orange

Background Colors

#f6f8f6

background-light

#102212

background-dark

#ffffff

surface-light

#1a2e1d

surface-dark

Text Colors

#0d1c0e

text-main

#4b9b51

text-secondary

Feedback Colors

#F5C542

gold (perfect)

#2D7FF9

blue (good)

#94A3B8

gray (needs work)

Usage in Tailwind

className="bg-primary text-text-main"
className="border-primary/20 hover:bg-primary/10"
className="bg-gold text-white" // Perfect score