Skip to main content

Quick Start

Get your own branded, AI-powered dashboard running in less than 5 minutes.

Overview​

LibreApps Desktop is optimized for speed. This guide will take you from a fresh clone to a running, customized dashboard using our automated tools.

5-Minute Setup​

1. Clone the Repository​

git clone https://github.com/libre-apps/LADesktop.git
cd LibreApps Desktop

2. Install Dependencies​

Ensure you have pnpm installed on your machine.

# Navigate to the full-kit application
cd build/web/full-kit

# Install packages
pnpm install

3. Environment Setup​

Copy the example environment file. For a quick start, the defaults are usually sufficient for local development.

cp .env.example .env

4. Run the Dashboard​

pnpm dev

Open http://localhost:3000 in your browser.

The "One-Command" Rebrand​

The true power of LibreApps Desktop is its rebranding engine. Try it now:

  1. Open Settings: Open rebrand/settings.md in your editor.
  2. Change App Name: Change the App Name from "LibreApps Desktop" to "MyCoolApp".
  3. Run Rebrand: In your terminal, from the project root, run:
./scripts/build-rebrand.sh
  1. View Changes: Restart your dev server in build/web/full-kit. You will see your new app name in the navbar and footer.

What's Included?​

Your fresh installation includes:

  • ✅ Full UI Kit: All shadcn components and layouts.
  • ✅ Standard Apps: Email, Chat, Kanban, and Calendar.
  • ✅ Analytics: A complete analytics dashboard with demo data.
  • ✅ Theme Gallery: Visit /en/themes/gallery to swap themes instantly.

Success Checklist​

Before moving to production, ensure you can:

  • Run the development server (pnpm dev)
  • Perform a successful rebrand (./scripts/build-rebrand.sh)
  • Log in to the dashboard (default login details in .env)
  • Navigate through the sample apps and dashboards

Need a deeper dive? Installation Guide →