Getting Started
Everything you need to know to get started with SWORD
Introduction
SWORD is a multi-tenant SaaS platform that allows you to create and manage multiple tenants under a single application. Each tenant operates on its own subdomain, providing isolation and customization options.
This guide will walk you through the process of creating an account, setting up your first tenant, and getting familiar with the platform's core features.
Note: This documentation is intended for SWORD version 1.x. Some features may be in active development and subject to change.
Key Features
Multi-Tenant Architecture
Host multiple tenants under a single application with subdomain isolation.
User Management
Upload and manage users via CSV or invite them individually via email.
Team Functionality
Create and manage teams within each tenant for better organization.
Course Management
Create and manage courses with rich content and materials.
Custom Branding
Customize your tenant with your own logo and branding elements.
API Access
Integrate with external systems using our comprehensive API.
System Requirements
- Development:Local environment with Node.js 18+ and MySQL database
- Production:Vercel, Netlify, or any platform that supports Next.js applications
- Database:MySQL (via Prisma ORM), other databases with configuration
Next Steps
Quick Start Guide →
Set up your first tenant in minutes with our step-by-step guide.
Understanding Multi-Tenancy →
Learn about the underlying architecture of our platform.
User Management →
Learn how to add and manage users in your tenant.
API Documentation →
Explore our API for programmatic access to your tenant data.