Introduction

Welcome to the official Alkademi LMS Open Source documentation. This project is a modern Learning Management System (LMS) solution designed for maximum flexibility.

What is Alkademi LMS Open Source?

Alkademi LMS Open Source is a full-stack monolith learning platform built using Nuxt.js 4. Unlike traditional monoliths that often become "big balls of mud" (spaghetti code) as features grow, this project uses a Modular Monolith approach.

By leveraging Nuxt Layers, we divide the application into independent feature modules. Each module has its own pages, components, state (Pinia), and server API.

Architecture Philosophy

1. Feature-Driven Development

We believe that organizing code by feature (business domain) makes more sense than organizing it by technical type (like putting all components in one large folder).

• Cores: Main features that are built-in.
• Plugins: Additional features or customizations.

2. Limitless Extensibility

A major issue in open-source software is when users want to modify core features but don't want to break compatibility for future updates. Our Plugin system allows you to "Override" core components or APIs without touching a single line of code in the cores/ folder.

3. Developer Experience (DX)

This project is designed so developers can immediately focus on writing features. With the Auto-Discovery feature, you simply create a new folder in cores/ or plugins/, and Nuxt takes care of the rest:

• Automatic Route registration.
• Component auto-import.
• Server API registration.
• Store integration.

Who is this for?

• Educational Institutions: Those who need a custom LMS but want a solid and modern codebase.
• Developers: Those who want to build educational platforms with an architecture tested for scalability.
• Open Source Contributors: Those who want to help build the future of a more open education platform.

Ready to get started? Proceed to the Installation guide.