QELOS - Build SaaS Applications with Ease

A powerful platform for creating multi-tenant SaaS applications with a built-in plugin system

What is QELOS?

QELOS is a platform to create SaaS products with a set of tools for developers and non-developers to manage, edit, improve, and change SaaS products faster and easier.

Key Features

• 🚀 Multi-Tenant Architecture - Built-in support for multi-tenancy with isolated workspaces and configurations
• 🔌 Plugin System - Extend your application with plugins and micro-frontends
• 🎨 No-Code Builder - Create and customize blueprints without writing code
• 🔒 Built-in Security - Authentication, authorization, and secrets management out of the box
• 📦 Modern Tech Stack - Vue 3, Node.js, MongoDB, Redis, and more
• 🌐 API-First Design - RESTful APIs and SDK for seamless integration

Prerequisites

• Node.js v20+: The JavaScript runtime environment required to run QELOS
• Docker: For containerized development and deployment
• MongoDB: Database for storing application data (can be run via Docker)
• Redis (Optional): For caching and session management

Quick Start

Installation

# Clone the repository
git clone https://github.com/qelos-io/qelos.git

# Install dependencies
pnpm install

# Build the packages
pnpm build

Development Mode

# With local MongoDB instance
pnpm dev

# Create initial data (in a new terminal)
pnpm populate-db

Production Mode

pnpm start

Default Login Credentials

Field	Value
Username	test@test.com
Password	admin

Dockerized Usage

Setup Environment

cd compose

# For Linux or macOS
cp .env.example .env

# For all operating systems
pnpm run create-env

Run with Docker Compose

cd compose
docker-compose up

Scaling with Docker Compose

For scaled deployments with separate services:

cd compose
docker-compose -f docker-compose.scaled.yml up

Kubernetes Deployment

Prerequisites

• Docker Desktop with Kubernetes enabled
• kubectl
• Helm 3.x

Local Development Setup

1. Set up a Local Kubernetes Cluster

   # Verify cluster is running
   kubectl cluster-info

2. Install Helm (macOS)

   brew install helm

3. Deploy QELOS

   # Generate Helm values
   node --env-file .env tools/ingest-helm-values/index.js
   
   # Deploy or upgrade
   helm upgrade --install qelos -f ./helm/qelos/values-env.yaml ./helm/qelos
   
   # Forward the gateway service port
   kubectl port-forward svc/gateway-service 3000:80

4. Access the admin interface at http://localhost:3000

Project Structure

• /apps - Microservices and frontend applications

  • /admin - Admin frontend (Vue 3)
  • /ai - AI service for chat completion and AI integration
  • /auth - Authentication service
  • /content - Content management service
  • /plugins - Plugin management service
  • /redis - Redis service
  • /db - Database service
  • /gateway - Gateway service
  • /secrets - Secrets management service
  • /drafts - Drafts management service
  • /no-code - No-code management service

• /packages - Shared libraries and utilities

  • /api-kit - API utilities for backend services
  • /global-types - Shared TypeScript types
  • /cache-manager - Cache management service
  • sdk - SDK for frontend applications
  • plugin-player - Plugin sdk tool for plugin services
  • web-sdk - Web sdk tool for web micro-frontends and communication with qelos client side

• /documentation - Project documentation

• /compose - Docker Compose configuration

• /helm - Kubernetes Helm charts

Documentation

For comprehensive documentation, visit docs.qelos.io:

• Installation Guide
• Create Blueprints
• Plugin Development
• Deployment Guide

Resources

• Official Website
• Documentation
• GitHub Repository
• LinkedIn