Elfra

E-Learning Framework

How to Install and Use:

To install and use our service, we use docker to containerize it.

⚠️ IMPORTANT ⚠️

Make sure you have supabase setup and created a ".env" file with the necessary environment variables. You can use the ".env.example" file as a reference.

---

We recommed to download the latest stable release and not use the main branch for your install!

---

Method 1: Build it for later re-use of the Image

To Build the current Version use the command:

docker compose build

This builds the container under the name "Elfra" with the current version as "tag".

To run the container now use this command:

docker compose up *This will start the latest Version used in docker compose

OR THIS

 docker run -d \
  --name elfra-app \
  -p 3000:3000 \
  -v ~/elfra/courses:/app/content/courses \
  -v ~/elfra/config:/app/customconfig \
  -e NODE_ENV=production \
  --restart unless-stopped \
  elfra:1.0.0

Replace "x.x.x" with the version number of the tag you are installing. E.g.: 1.0.0
🚩 If you use this command you have to use docker stop <container_id_or_name> to stop it

Now you can stop/end the container by using

docker compose stop Keeps files and mounted volumes

OR

docker compose down !! If you use "down" the container will also get removed !!

---

Method 2: Build and start it

To Build the current Version use the command:

docker compose up --build

This builds the container under the name "Elfra" with the current version as "tag" and also starts it.

Now you can stop/end the container by using

docker compose stop Keeps files and mounted volumes

OR

docker compose down !! If you use "down" the container will also get removed !!

---

⚠️ With all methods the image and firsttime mounted volumes will always persist so you can use it later to build other instances!

---

Its importand to know that you will get 2 folder bind into the docker container:

📂: elfra_courses
📂: elfra_config

elfra_courses

This folder is generated in your Home directory (~/elfra/courses) on first start of the container. Here you can manage your WBTs and edit them. For now you have to make them by hand (Tutorial). Later they will be generated by the Elfra Config Tool

elfra_config

This folder is generated in your Home directory (~/elfra/config) on first start of the container. This folder is home to your config.ts file wich is beeing created and edited by the Elfra Config Tool

Figma Project

Elfra on Figma

We use NUXT!

Look at the Nuxt documentation to learn more.