Getting Started — Blazor Blueprint
Login Register

💡 The full stack — MongoDB or PostgreSQL / SQL Server, Redis, Kafka, the API microservice, and the background worker — ships in one product. Run the pieces you need; MongoDB single-process is the simplest default.

Prerequisites

  • .NET 10.0 SDK - Download from Microsoft
  • Docker Desktop - For the database (MongoDB / PostgreSQL / SQL Server), Redis, Kafka, and containerized deployment
  • IDE: Visual Studio 2022, VS Code, or JetBrains Rider
  • Git - For version control

💡 Tip: .NET Aspire handles Redis and Kafka automatically in development. For the default MongoDB backend you configure MongoDB separately (local instance or cloud service).

🗄️ Pluggable data layer: The backend is selected by Database:DatabaseTypemongodb (default), postgresql, or sqlserver. When you set postgresql or sqlserver, the Aspire AppHost auto-provisions the matching database container; the default MongoDB backend is external.

Installation

  1. Clone the repository:
    git clone https://github.com/BlazorBlueprint/Blazor-Blueprint.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. Provide the database: For the default MongoDB backend, run local MongoDB or configure a cloud connection in appsettings.json. For postgresql / sqlserver, the Aspire AppHost provisions the container automatically — no separate step.
  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, Kafka, the Web app, the API service, and the background worker with proper networking and random ports. For the default MongoDB backend you provide MongoDB separately; for postgresql / sqlserver it also provisions the database container.

⚠️ Development vs Production: With the default MongoDB backend, Aspire development setup does NOT include MongoDB (you provide it separately), while CI/CD production deployment includes MongoDB with persistent storage. The relational backends (postgresql / sqlserver) run in a container in both.

Option 2: Manual Setup

If you prefer not to use Aspire:

  1. Start the database and Redis: (default MongoDB backend shown)
    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": { "DatabaseType": "mongodb", "ConnectionString": "mongodb://localhost:27017" }
    "ConnectionStrings": { "redisCache": "localhost:6379" }

    Set DatabaseType to postgresql or sqlserver (with a matching ConnectionString) to run on a relational backend instead.

  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. Complete initial setup: A fresh install auto-redirects to /initial-setup, where you create the first Owner account and the platform organisation. (The Register page is for later members — it creates a regular member, not an admin.)
  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. Build and explore plugins: The template ships with no bundled plugins — you build your own against the IPlugin model. Each installed plugin opens from the launcher into its own dashboard under a plugin-specific sidebar (/plugin/{your-plugin}/...), with settings under /admin/plugin/{your-plugin}/....
  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), turn off the Public workspace switch in /Admin/Pages. 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 full product free — use it, including commercially, while you're under £100k/year revenue; a commercial licence (from £499) applies above that.

🔓 Source-available on GitHub • Free under £100k/yr revenue • Commercial licence (from £499) above that • Full source code included

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