Getting Started - Blazor Blueprint Installation & Setup Guide
Login Register

📋 Prerequisites

  • .NET 10.0 SDK - Download from Microsoft
  • Docker Desktop - For MongoDB, Redis, and containerized deployment
  • IDE: Visual Studio 2022, VS Code, or JetBrains Rider
  • Git - For version control

💡 Tip: .NET Aspire handles Redis automatically in development. You'll need to configure MongoDB separately (local instance or cloud service).

⚙️ Installation

  1. Clone the repository:
    git clone https://github.com/BlazorBlueprint/Blazor-Blueprint-Lite.git your-saas-app
    cd your-saas-app
  2. Restore dependencies:
    dotnet restore BlazorBlueprint.sln
  3. Build the solution:
    dotnet build BlazorBlueprint.sln

💻 Development Setup

Option 1: .NET Aspire (Recommended)

  1. Start MongoDB: Run local MongoDB or configure cloud connection in appsettings.json
  2. Set Dev/BlazorBlueprint.AppHost as startup project in Visual Studio
  3. Press F5 or click Run
  4. Aspire dashboard opens automatically showing all services
  5. Click the Web endpoint to access your application

✨ What Aspire Does: Automatically starts Redis, Web app, and API service with proper networking and random ports. You need to provide MongoDB separately.

⚠️ Development vs Production: Aspire development setup does NOT include MongoDB (you provide it separately), while CI/CD production deployment includes MongoDB with persistent storage.

Option 2: Manual Setup

If you prefer not to use Aspire:

  1. Start MongoDB and Redis:
    docker run -d --name mongodb -p 27017:27017 mongo:latest
    docker run -d --name redis -p 6379:6379 redis:latest
  2. Update connection strings in appsettings.json:
    "Database": { "ConnectionString": "mongodb://localhost:27017" }
    "ConnectionStrings": { "redisCache": "localhost:6379" }
  3. Run the web application:
    dotnet run --project Web/BlazorBlueprint.Web

🎯 First Run

  1. Access the application: Navigate to the Web endpoint shown in the Aspire dashboard (port changes each run)
  2. Create admin account: Click "Register" and create your first user account
  3. Land on the app launcher: After signing in (and any org selection / creation), you'll land on /apps — an Odoo-style tile grid of installed plugins plus an Admin tile for organisation settings and a Platform Admin tile for platform-level management. The launcher is the canonical home for signed-in members and is controlled by Features:AppLauncher (default on).
  4. Explore the bundled plugins: CRM, CMS, and LiveChat each open from the launcher into their own dashboard under a plugin-specific sidebar (CRM → contacts, jobs, quotes; CMS → pages, blog, sitemap; LiveChat → chat groups, support tickets). Plugin settings stay in /Admin/Plugin/{name}/....
  5. View infrastructure: Visit Infrastructure Monitor to see system status (requires a platform admin account)

🎯 Next Steps: If you want to run the org as a private workspace (members-only, no public site), toggle Private workspace in /Admin/OrganisationSettings. Anonymous visitors then bounce to sign-in and the org is excluded from robots.txt + sitemap.xml.

📦 Ready to Download?

Get started building your SaaS application today. Download the free Developer version or upgrade to Enterprise for commercial use and premium features.

🔓 Open Source on GitHub • Free for personal/non-commercial use • Enterprise license (£399) required for commercial use • Full source code included

Welcome! How can we help you today?
An unhandled error has occurred. Reload