Run Learnio locally

1. 01

   Download your template

   Open My templates and download the Learnio ZIP for your package.

   • My templates

   Watch step0:07

   Expected result: A file named like learnio-lms-main-….zip is in your downloads.

   I've done this step
2. 02

   Unzip and open the folder

   Extract the ZIP and open a terminal in the learnio-lms folder. On Windows, extract it in File Explorer, then open a terminal in the folder.

   TerminalCopy

   unzip learnio-lms-*.zip
   cd learnio-lms

   Watch step0:08

   Expected result: The folder lists admin-dashboard, back-end, frontend and docker-compose.yml.

   Having trouble?

   I've done this step
3. 03

   Start the apps

   Build and start the API, the student site and the admin dashboard. The first start builds three images and fills the database with the demo data, which takes a few minutes; later starts take seconds.

   Terminalin learnio-lmsCopy

   docker compose up --build

   A port is already in use?

   If the start stops with ports are not available ... address already in use, another program uses 3030, 3031 or 8000. Either stop it, or create a file named .env in the learnio-lms folder with the port you need, such as ADMIN_PORT=3041 (SITE_PORT for the student site, API_PORT for the API). Run docker compose up --build again and open the app on its new port.

   A port is already in use

   Watch step0:09

   Expected result: The three services keep running and the log stops scrolling. Leave this terminal open.

   Having trouble?

   I've done this step
4. 04

   Open the student site

   Open localhost:3030Local and sign in as the demo student: demo@learnio.com with the password Demo@123.

   Watch step0:07

   Expected result: The catalogue loads, and signing in opens the learner dashboard.

   Having trouble?

   I've done this step
5. 05

   Sign in to the admin

   Open localhost:3031Local. The super admin is admin@learnio.com with the password Admin@123. Change it after your first sign-in.

   Watch step0:05

   Expected result: The admin dashboard opens on its overview.

   Having trouble?

   I've done this step

Take a tour

What the demo data looks like once everything runs: the student site with its catalogue, opened on a course.

Browse the catalogue and open a course0:07

Eleven more staff accounts exist at *@learnio.com with the password admin123, each on a different role, so you can see the permissions from the inside. These are local demo accounts only.

Stop and start again

Press Ctrl+C in the terminal to stop the apps, or run this from the learnio-lms folder. Your data is kept in the learnio-data volume.

docker compose down

Start again with the same command as step 3. Without --build it reuses the images you already built.

docker compose up

Run the student site

This package is the student site on its own. It runs on its bundled sample data until you point it at a Learnio API. The API is a separate package and is not in this download.

1. 01

   Download your template

   Open My templates and download the student site ZIP.

   • My templates

   Watch step0:07

   I've done this step
2. 02

   Unzip and open the folder

   TerminalCopy

   unzip frontend-*.zip
   cd frontend

   Watch step0:07

   Expected result: The folder has a Dockerfile and a package.json.

   I've done this step
3. 03

   Build the image

   The NEXT_PUBLIC_* values are compiled into the JavaScript the browser loads, so they are build arguments. Leave them out to run on the sample data; to use your own API, pass its address.

   Terminalin frontendCopy

   docker build -t learnio-site .

   With your own API:

   Terminalin frontendCopy

   docker build -t learnio-site --build-arg NEXT_PUBLIC_API_BASE_URL=https://api.your-domain.com/api --build-arg NEXT_PUBLIC_SITE_URL=https://your-domain.com .

   Watch step0:08

   I've done this step
4. 04

   Start it

   If port 3030 is taken, change the number on the left of -p, for example -p 3041:3030, and open that port instead.

   Terminalin frontendCopy

   docker run -p 3030:3030 learnio-site

   Watch step0:08

   Expected result: localhost:3030Local opens the site. Without an API, a "Sample data" notice at the bottom of the page says so.

   Having trouble?

   I've done this step

Run the admin dashboard

This package is the admin dashboard on its own. Without an API it runs on an in-browser mock: you can sign in and look around, but most screens stay empty until you connect a Learnio API. The API is a separate package and is not in this download.

1. 01

   Download your template

   Open My templates and download the admin dashboard ZIP.

   • My templates

   Watch step0:07

   I've done this step
2. 02

   Unzip and open the folder

   TerminalCopy

   unzip admin-dashboard-*.zip
   cd admin-dashboard

   Watch step0:08

   Expected result: The folder has a Dockerfile and a package.json.

   I've done this step
3. 03

   Build the image

   Without build arguments the dashboard uses its mock. To use your own API, pass its address, its WebSocket address (the same server without /api) and the student site's address.

   Terminalin admin-dashboardCopy

   docker build -t learnio-admin .

   With your own API:

   Terminalin admin-dashboardCopy

   docker build -t learnio-admin --build-arg NEXT_PUBLIC_API_BASE_URL=https://api.your-domain.com/api --build-arg NEXT_PUBLIC_WEBSOCKET_BASE_URL=https://api.your-domain.com --build-arg NEXT_PUBLIC_SITE_URL=https://your-domain.com .

   Watch step0:08

   I've done this step
4. 04

   Start it and sign in

   If port 3031 is taken, change the number on the left of -p, for example -p 3041:3031, and open that port instead.

   Terminalin admin-dashboardCopy

   docker run -p 3031:3031 learnio-admin

   Watch step0:09

   Expected result: localhost:3031Local opens the sign-in form, prefilled with admin@learnio.com and Admin@123. On the mock, any email and password sign you in as the super admin.

   Having trouble?

   I've done this step

Run the API

This package is the NestJS API on its own, on a SQLite file kept in a Docker volume. The student site and the admin dashboard are separate packages and are not in this download.

1. 01

   Download your template

   Open My templates and download the API ZIP.

   • My templates

   Watch step0:07

   I've done this step
2. 02

   Unzip and create the environment file

   .env.example works as it is for a local run.

   TerminalCopy

   unzip back-end-*.zip
   cd back-end
   cp .env.example .env

   Watch step0:08

   I've done this step
3. 03

   Build the image

   Terminalin back-endCopy

   docker build -t learnio-api .

   Watch step0:08

   I've done this step
4. 04

   Start it with the demo data

   A fresh database gets empty tables unless you ask for the demo data. The volume keeps the database between runs. If port 8000 is taken, change the number on the left of -p, for example -p 8010:8000, and use that address: your frontends must then point at http://localhost:8010/api.

   Terminalin back-endCopy

   docker run -p 8000:8000 -v learnio-data:/data -e SEED_DEMO_DATA=true --env-file .env learnio-api

   Watch step0:09

   Expected result: localhost:8000/api/healthLocal answers with a status of ok.

   Having trouble?

   I've done this step

Without a JWT_SECRET of your own, or with the example one, the container generates a secret and keeps it in the volume.

Next

• Set your environment variables
• Run it without Docker
• Fix a setup problem