Maigie

AI-powered student companion that helps learners manage courses, set goals, discover resources, schedule study sessions, get forecasts and reminders, and converse with an intelligent assistant (text + voice).

Architecture

This is an Nx monorepo containing:

• Backend (apps/backend) - FastAPI application
• Web (apps/web) - Vite + React + shadcn-ui application
• Mobile (apps/mobile) - Expo (React Native) application

Shared Libraries

• libs/types - Shared TypeScript types & API client
• libs/ui - Shared UI components (web & mobile where possible)
• libs/auth - Shared auth helpers (token helpers)
• libs/ai - Shared prompts, schema for AI interactions
• libs/db - Prisma schema + migrations

Getting Started

Prerequisites

• Node.js 18+ (or 20+ recommended)
• Python 3.11+
• Poetry (for Python dependencies)

Installation

# Install Node.js dependencies
npm install

# Install Python dependencies (for backend)
cd apps/backend
poetry install

Development

# Run web app
nx serve web

# Run mobile app
nx serve mobile

# Run backend
nx serve backend

Project Structure

Maigie/
  ├─ apps/
  │   ├─ backend/                # FastAPI app (Python)
  │   ├─ web/                    # Vite + React (shadcn-ui)
  │   └─ mobile/                 # Expo (React Native)
  ├─ libs/
  │   ├─ types/                  # shared TypeScript types & API client
  │   ├─ ui/                     # shared UI components
  │   ├─ auth/                   # shared auth helpers
  │   ├─ ai/                     # shared prompts, schema for AI interactions
  │   └─ db/                     # Prisma schema + migrations
  ├─ docs/
  │   └─ architecture/           # Architecture documentation
  ├─ nx.json
  ├─ package.json
  └─ README.md

Deployment

Web App (Cloudflare Pages)

The web application is configured for deployment to Cloudflare Pages. See docs/deployment/cloudflare-pages.md for detailed deployment instructions.

Quick Setup:

• Build command: npm install && nx build web
• Output directory: dist/apps/web
• Node version: 20 (see .nvmrc)

Documentation

See docs/architecture/ for detailed architecture documentation.

See docs/deployment/ for deployment guides.

License

GNU Affero General Public License v3.0 (AGPL-3.0)

See LICENSE for the full license text.