Installation

Follow the steps below to install Alkademi LMS Open Source in your local environment.

Prerequisites

Before starting, make sure your machine has the following installed:

• Node.js: Version 20.x or newer.
• Package Manager: We strongly recommend using pnpm for speed and storage efficiency, though you can also use npm or yarn.
• Git: To clone the repository.

Installation Steps

1. Clone Repository

Open your terminal and run the following command:

git clone https://github.com/Alkademi-Development/lms-alkademi-monolith.git lms-opensource
cd lms-opensource

2. Install Dependencies

Use your preferred package manager to download the required libraries:

# If using pnpm (recommended)
pnpm install

# If using npm
npm install

3. Environment Configuration

The current project version does not require .env configuration to run the built-in pages and example features. When database, authentication, or external service integrations are added, create .env based on that feature's documentation.

4. Run Development Server

Run the following command to start the development server:

pnpm run dev

The server will run at http://localhost:3000. Open that address in your browser.

What's Next?

After successfully running the application, you can:

• Learn about the Project Structure to understand where the code is located.
• See how the Layer Architecture works.
• Try creating your first Plugin.