edulution UI

Overview

Edulution is a comprehensive, all-in-one solution for modern educational institutions. The modular and scalable digital package for multi-school environments covers all aspects of educational operations and can be customized to meet a wide range of requirements.

Development

Description

A Full Stack Application build with Vite+React (frontend) and Nest.js for the API. NX is used to organise the monorepo.

Maintenance Details

Community support	✅ YES
Actively developed	✅ YES

Getting Started

Prerequisites

• Node.js 22 LTS
• Running MongoDB
• Running Redis

Public Key

Read the public key and certificate from oidc provider (Keycloak >> realm settings >> keys). Then add edulution.pem file to the project root. Insert the key/cert as follwed:

-----BEGIN CERTIFICATE-----
<CERTIFICATE CONTENT>
-----END CERTIFICATE-----
-----BEGIN PUBLIC KEY-----
<PUBLIC KEY CONTENT>
-----END PUBLIC KEY----

Installation

1. Install dependencies:

   npm install

2. Place a .env file in apps/api and a .env.development file in apps/frontend (.env.default as template)

3. Setup redis and mongoDB via docker-compose.yml

   docker compose pull
   docker compose up -d

4. Start API

   npm run api

   The API will be served on http://localhost:3001/

5. Start Frontend

   npm run dev

   The frontend will be served on http://localhost:5173/

6. Production build

   npm run build:all

Documentation

Visit https://docs.edulution.io/

Build

Build local

npm run build:all && \
docker build -t ghcr.io/edulution-io/edulution-ui -f apps/frontend/Dockerfile .&& \
docker build -t ghcr.io/edulution-io/edulution-api -f apps/api/Dockerfile .&& \
docker compose up -d

Deploy

Visit https://get.edulution.io to get the deployment script. Or copy:

bash <(curl -s https://get.edulution.io/installer)