Khadem Logo
Khadem BETA

Installation Guide

Get started with Khadem — the Laravel-inspired, Dart-powered backend framework. This comprehensive guide will walk you through installing Khadem and setting up your development environment.

⚡

Quick Start

Already have Dart installed? Skip to Khadem Installation

System Requirements

Khadem requires the following minimum system specifications:

✅ Required

  • Dart SDK: 3.0.0 or higher
  • Operating System: Windows, macOS, Linux
  • RAM: 512MB minimum, 1GB recommended
  • Storage: 100MB free space

🔧 Optional

  • Docker: For containerized deployments
  • MySQL/PostgreSQL: For database features
  • Redis: For caching and queues
  • Git: For version control

Prerequisites

Before installing Khadem, ensure you have the following installed:

Dart SDK Installation

Khadem requires Dart SDK 3.0.0 or higher. Download and install Dart from the official website:

🪟
Windows
🍎
macOS
🐧
Linux

Verify Dart Installation

After installation, verify Dart is working correctly:

bash
# Verify Dart installation
dart --version

# Expected output: Dart SDK version: 3.1.0 (stable)

Expected output: dart --version should show something like "Dart SDK version: 3.1.0 (stable)"

Installing Khadem

Install Khadem globally using Dart's package manager:

bash
# Install Khadem globally
dart pub global activate khadem

# This will download and install Khadem CLI globally

Verify Khadem Installation

Confirm Khadem is installed and accessible:

bash
# Verify Khadem installation
khadem --version

# Should display: Khadem CLI version x.x.x

Expected output: Should display Khadem version information

Updating Khadem

Keep Khadem up-to-date with the latest features and bug fixes:

bash
# Update to the latest version
dart pub global activate khadem

# Force update if needed
dart pub global activate khadem --overwrite

Tip: Run this command regularly to stay updated with the latest Khadem version

🔄 Version Conflicts

If you encounter version conflicts:

bash
# Uninstall and reinstall Khadem
dart pub global deactivate khadem
dart pub global activate khadem

Post-Installation Checklist

Dart SDK 3.0.0+ installed
Khadem CLI installed globally
Khadem accessible via command line
IDE configured with Dart support

Next Steps

Khadem is now installed and ready! Continue with these guides:

🚀

Create Your First Project

Learn how to scaffold your first Khadem application

⚙️

Configuration

Set up environment variables and app configuration

Need Help?

Having trouble with installation? Check out our community resources:

Report an Issue → Community Discussions →

On this page