Skip to main content

Prerequisites

Before you begin, make sure you have the following tools installed:

Node.js 18+

Required runtime for Angular CLI and npm scripts.

npm 9+

Package manager for installing project dependencies.

Angular CLI v20+

Command-line interface for building, serving, and scaffolding the app.

Git

Version control for cloning the repository and managing changes.
A code editor is also required. VS Code is recommended for its Angular ecosystem support.

Getting started

1

Fork and clone the repository

Fork the gems-lms-web repository on GitHub, then clone your fork locally:
git clone https://github.com/<your-username>/gems-lms-web.git
cd gems-lms-web
2

Install dependencies

Install all project dependencies using npm:
npm install
This installs Angular, its peer dependencies, and all packages listed in package.json.
3

Start the development server

Start the local development server with Angular CLI:
ng serve
The app reloads automatically whenever you save a file. You do not need to restart the server manually after making changes.
4

Open the app in your browser

Visit http://localhost:4200 to see Karma LMS running locally. The page will reflect your changes in real time.

Code scaffolding

Angular CLI provides ng generate to create new files following Angular conventions. Use it to avoid writing boilerplate by hand.
ng generate component component-name
Run ng generate --help to see the full list of schematics available in your Angular CLI version, including guards, pipes, directives, and more.
Install these two extensions to get inline Angular template validation, autocompletion, and linting directly in your editor:
  • Angular Language Service — provides type-checking and autocompletion inside Angular templates.
  • ESLint — surfaces linting errors as you type, keeping your code consistent with the project’s style rules.

Build docs developers (and LLMs) love