create-mls-app

Create a new MLS Framework app with a single command

The easiest way to get started with MLS Framework - a modern, mobile-first learning management system.

✨ Features

• 🚀 Instant Setup - Get a full learning app in minutes
• 🔐 Supabase Integration - Automatic database and auth setup
• 📱 Mobile Ready - Capacitor configuration included
• 🌙 Modern UI - Beautiful dark theme and responsive design
• ⚡ Production Ready - Optimized builds and deployment ready

🚀 Quick Start

Interactive Setup (Recommended)

npx create-mls-app my-learning-app

Follow the interactive prompts to configure your app!

Command Line Options

# Skip npm install
npx create-mls-app my-app --skip-install

# Skip git initialization
npx create-mls-app my-app --skip-git

# Combine options
npx create-mls-app my-app --skip-install --skip-git

📋 Interactive Setup

The CLI will ask you:

1. 📝 Project Name - Your app's name
2. 🔐 Supabase Config - Your database credentials
3. 📱 Mobile Setup - Enable Capacitor for mobile apps
4. ✨ Additional Features - Dark mode, analytics, etc.

🎨 What You Get

The MLS Framework includes:

• Complete learning management system with all features
• Authentication & user management
• Course & quiz system
• Progress tracking & analytics
• Mobile app ready with Capacitor
• Perfect for: Production learning platforms

🛠️ What You Get

After running the CLI, you'll have:

my-learning-app/
├── src/
│   ├── app/                 # Next.js App Router pages
│   ├── components/          # React components
│   ├── hooks/              # Custom hooks
│   └── utils/              # Utility functions
├── public/                 # Static assets
├── .env.local             # Environment variables (if configured)
├── capacitor.config.ts    # Mobile app config (if enabled)
├── package.json           # Dependencies and scripts
└── README.md              # Project documentation

🚀 After Installation

cd my-learning-app

# Start development server
npm run dev

# Build for production
npm run build
npm start

# Mobile development (if enabled)
npx cap add android
npx cap add ios
npx cap run android

📚 What is MLS Framework?

MLS (Modular Learning System) Framework is a modern, production-ready learning management system built with:

• ⚡ Next.js 15 - Latest React framework with Turbopack
• 🔐 Supabase - Backend-as-a-Service with PostgreSQL
• 📱 Capacitor - Cross-platform mobile development
• 🎨 TailwindCSS - Utility-first CSS framework
• 🔒 TypeScript - Full type safety

Core Features

• 🎓 Course Management - Create and organize learning content
• 🧠 Interactive Quizzes - Multiple choice and single choice questions
• 📊 Progress Tracking - Real-time learning analytics
• 👥 User Management - Authentication and profiles
• 📱 Mobile Apps - iOS and Android native apps
• 🌙 Dark Mode - Beautiful modern interface

🔧 Requirements

• Node.js 18+
• npm or yarn
• Supabase account (for database)

📖 Documentation

• MLS Framework Docs - Complete documentation
• API Reference - API documentation
• Examples - Example projects
• Deployment Guide - Production deployment

🤝 Community

• GitHub Discussions - Community support
• Issues - Bug reports and feature requests
• Contributing - Contribution guidelines

📄 License

MIT License - see the LICENSE file for details.

🙏 Acknowledgments

Built with amazing open source projects:

• Next.js - React framework
• Supabase - Backend platform
• Capacitor - Mobile development
• TailwindCSS - CSS framework

Create your learning platform today!

Get Started • Documentation • Examples