Skip to main content
This guide walks you through the minimum steps to get Karma LMS running on your machine. For a complete environment walkthrough, see the Installation guide.

Prerequisites

Before you begin, make sure you have the following installed:
  • Node.js 18 or laternodejs.org
  • npm — bundled with Node.js
  • Angular CLI v20+ — installed globally (see step below)
  • Gitgit-scm.com

Get up and running

1

Install Angular CLI

Install the Angular CLI globally on your machine. You only need to do this once.
npm install -g @angular/cli
Verify the installation:
ng version
2

Clone the repository

Clone the Karma LMS source from GitHub.
git clone https://github.com/GEMS-INNOVATIONS/gems-lms-web.git
3

Install dependencies

Navigate into the project directory and install npm packages.
cd gems-lms-web
npm install
This installs all Angular dependencies listed in package.json.
4

Start the development server

Run the Angular development server.
ng serve
The build will compile and the server will start. Wait for the output to show:
✔ Compiled successfully.
5

Open the application

Open your browser and navigate to:
http://localhost:4200
The Karma LMS application will load and is ready to use.
The development server watches for file changes and automatically reloads the browser whenever you save a file. You do not need to restart the server during development.

What’s next

When you are ready to deploy, build an optimized production bundle with ng build. This compiles the application with ahead-of-time (AOT) compilation, tree-shaking, and minification. Output files are written to the dist/ directory.
ng build

Installation

Full environment setup, CLI command reference, and troubleshooting.

Courses

Learn how to create, manage, and publish courses in Karma LMS.

Development setup

Project architecture, testing, and build configuration for contributors.

Build docs developers (and LLMs) love