Blazor is a web framework designed to run in the browser on a WebAssembly-based .NET runtime. Blazor Boilerplate aka Blazor Starter Template is a SPA admin template that is able to run both WebAssembly (Core-Hosted) and Server-Side Blazor with a .NET Core 6.0 Server. Default mode for BB is Server Side. To switch to Webassembly log in as Admin and go to settings. Read more here

Repository Notes

Read the news below to stay up to date on the repo. We will try to keep the latest major changes on a different branch and have the more stable / tested version on the master branch.

Goals

This repository is community driven. It is not and never will be controlled by a corporation. It's success is dependent on people using it, reviewing it, offering suggestions and most importantly contributing. Please join the gitter discussion
To create a boilerplate with Blazor / Razor components that includes the most common functionality to start a real world application quickly.
Avoid many external components & libraries which can make it difficult to maintain, update, track down code, learn code and issues.
Minimal Javascript. Currently only using js for MudBlazor / Material Design. We may use components with JS in them but so far no Javascript has been written specifically for anything in the repository.

Live demo

Blazor Boilerplate - CSB/WASM - Kick the tires. *Note Firewall does block some foreign IP addresses. Swagger UI to view the server API https://blazorboilerplate.com/swagger/index.html.
Demo for MudBlazor Branch - Blazor Server Side Tenant
Demo for MudBlazor Branch - Blazor WebAssembly Tenant

Prerequisites

Don't know what Blazor is? Read here

Complete all Blazor dependencies.

The latest .Net 6.0 SDK
Install the Latest Visual Studio 2022 with the ASP.NET and web development workload selected. Ver. 3.1.0 is .net & Visual Studio 2019
Entity Framework Core on the command-line tools: dotnet tool install --global dotnet-ef

How to run

Install the latest Visual Studio 2022 (v17.0.1 at least)
Clone or download.
Review / Update appsettings.json - DefaultConnection.
Open the solution in Visual Studio and press F5.
To view the API using Swagger UI, Run the solution and go to: http://localhost:53414/swagger/index.html. Live example: https://blazorboilerplate.com/swagger/index.html

Publish on IIS - What works for me on my Windows Server 2016 & SQL Server 2014 (Enkodellc)

Publish BlazorBoilerplate.Server project to your IIS website folder.
Install your SSL. Make sure your SSL is in the WebHosting Certificate Store, and in Linux My Certificate Store.
- A free certificate from Let's Encrypt will work.
- For steps 2 & 3 the utility win-acme installs the certificate on your server, performs renewal and configure your IIS Website Bindings to have https binding with the SSL certificate set and Port 443 for default.
Configure your IIS Website Bindings to have https binding with the SSL certificate set and Port 443 for default. Enable WebSockets for SignalR.
Configure / create appsettings.production.config. Set Connection String. If you are using Sql Server then make sure your connection string contains MultipleActiveResultSets=true, Set Thumbprint / SSL. Thumbprint example: 143fbd7bc36e78b1bcf9a53c13336eaebe33353a
Login with either the user [user | user123] or admin [admin | admin123] default accounts.

Thanks To

Contributing

Please star, watch and fork! We'd greatly appreciate any contribution you make. I am very open to updates and features, though most feature requests will be depending on how much community support exists.

Disclaimer / About the Author

I (Enkodellc) started this repository as I was frustrated with the examples out there that people were charging money for and were in my opinion incomplete or closed source. I paid for 4-5 of these solutions with an Angular front-end / .Net Core back-end and none of them were what I was looking for. This is my attempt to create something that developers can start a Blazor project with several great features to build from. I have a lot of experience with ASP.Net webforms an new to .NET Core and Blazor. This code is not meant to be perfect or follow every best practice. It though is my ambition to learn and get feedback on what best practices can be implemented. I will be migrating a Webforms app to Blazor so this is my opportunity to learn, share, grow, and get feedback on what hopefully will be a great Blazor Starter Kit.

I have taken small solutions from other repositories and will do my best to recognize those contributions. I am very open to ideas and suggestions. I am not a great developer, but I try. So please take this into consideration when using this repository. If you wish to hire me for consulting or as a contractor please reach out via email or https://gitter.im/enkodellc. I have taken well over 1,000 hours to create, maintain, and answer questions. Please donate to support my efforts.

Completed

Basic Login / User Creation
Admin Theme using Material Design / MudBlazor - 12/1/2021 Switched from MatBlazor
Swagger UI API visualizer - View the live API
Log Files using Serilog
Choose between SQL Lite File or MS SQL Database or Postgres
Email Confirmation of Registered Users
Forgot Password Functionality
ISoftDelete Interface for Models - Allows for "trash / restore" of data IsDeleted property
IAuditable Interface for Models - Allows for CreatedOn, CreatedBy, ModifiedOn, ModifiedBy properties
Api Audit Trail / Middleware to log Api Requests and Responses
Api Response Class to maintain consistent Api Requests and Responses
Todo List CRUD Example with N-Tier Layers Not just some fluff that most others do
Seed Database & Database Migrations
Forum chat and notification system - Thanks ajgoldenwings
Drag and Drop Examples - Chris Sainty Blazor Blog
Docker Container Support
Dual Mode (CSB / SSB) - Client Side / Webassembly & Sever Side. Thanks MarkStega
Error Log to Database with Serilog & SQL. Thanks np-at

Road map

License

This project is licensed under the terms of the MIT license.

Problem Solving Tips

If you are having issues wih authentication or any other strange behavior try using Incognito mode / different browser.
Make sure you have all pre-requisites installed.
Keep It Simple Stupid: If you are running into issues with SQL / connection string. First CHECK both appsettings.json (appsettings.production.json for production) and (appsettings.development.json for development).
Test out with SQLlite / file db. Then test out with a known good connection string.
Go back to the Origin: BlazorBoilerplate was built off of BlazorWithIdentity so first step is to run this and try and publish. The reasoning is that this is a very lean project to reduce the amount of code and resources requiring debugging.
If still failing get on Gitter BlazorBoilerplate for Blazor Boilerplate or Gitter aspnet/Blazor.
Debugging is very limited on WebAssembly / Client-side Blazor. Use Debug_SSB for debugging the UI. Just be aware of browser caching issues when switching modes. The server side of the project can easily be debugged, just not there yet on the client-side code.
If you are getting compiler errors try and close VS delete your .vs directory in the solution folder. If that doesn't work delete the solution and redownload the repo.

Postgres Support

*Note this might be out of date.. Delete Existing Migrations in the BlazorBoilerplate.Server/Migrations Folder and then create your own migrations:
-dotnet ef --startup-project ..\BlazorBoilerplate.Server migrations add InitialApplicationDbMigration --context ApplicationDbContext -o Migrations\ApplicationDb
-dotnet ef --startup-project ..\BlazorBoilerplate.Server\ migrations add InitialConfigurationDbMigration --context ConfigurationDbContext -o Migrations\ConfigurationDb
-dotnet ef --startup-project ..\BlazorBoilerplate.Server\ migrations add PersistedGrantDbContext --context PersistedGrantDbContext -o Migrations\PersistedGrantDb

Docker Support

Prerequisite: Install Docker Desktop
Include / Reload docker-compose project in solution.
Do Docker stuff - I don't have much experience with Docker.
In the command line go to the Utils folder and run "docker-compose build". Once complete run "docker-compose up"
The following will happen in the browser with ASPNETCORE_ENVIRONMENT=Development:
Connecting via localhost in chrome or firefox: You will get a console error: "Cannot assign requested address (localhost:port)" - because the js client is trying to connect to your local machine rather than the docker container. Login will not work.
Connecting over external ip address/dns: Login will work, but you will get a console error in the following scenarios:
In chrome over http: Cannot read property 'register' of undefined. Login works. After login: There is no additional error.
In chrome over https: 1) An SSL certificate error occurred when fetching the script; 2) DOMException: Failed to register a ServiceWorker for scope ('https://x.x.x.x:port/') with script ('https://x.x.x.x:port/service-worker.js'); Login works. After login: There is no additional error.
In firefox over http: 1) navigator.serviceWorker is undefined. Login works. After login: WebSocket is not in the OPEN state
In firefox over https: 1) No errors. Login works. After login: WebSocket is not in the OPEN state.
In ASPNETCORE_ENVIRONMENT=Production: http will redirect to https. If you are using a self signed/invalid ssl certificate the following will occur:
In chrome or firefox over https: Same as above except login will fail. After login attempt: There was an unhandled exception on the current circuit, so this circuit will be terminated.
Note: In Production, if the httpClientHandler server certificate validation returns false (caused by a self signed/invalid ssl certificate) then the login will fail. In Development, overriding the certificate validation via ServerCertificateCustomValidationCallback = () => { return true; } prevents the ssl cert validation from failing which causes the login to succeed.

Azure Support

Azure Hosting Wiki
*Note that Azure isn't as up to date with their SDK as Blazor Boilerplate so you might have to use an older version

News

4.0.0 Net Core 6

MudBlazor 6
EF 5 - Waiting on Breeze Updates
Nuget Package Updates

3.1.0 MudBlazor

Virtual Table
MudBlazor 5
.net Core 6, VS 2019, Linux Friendly

3.0.0 Net Core 5

2.0.0 Development is now Master (Major Project Refactor - Thanks GioviQ) (Documentation)

Localization Support. Thanks GioviQ
DotNet Template Solution. Thanks GioviQ
Update to Identity Server 4.1.0,. Thanks GioviQ
Demo for Development Branch - SSB
Demo for Development Branch - CSB
Nuget Package Updates / WebAssembly 3.2.1

1.0.0 - Master branch

Nuget Package updates Blazor 3.2 - Production!

0.8.2 - Master branch

Nuget Package updates

0.8.1 Stable - Master branch

Blazor WebAssembly 3.2.0 Preview 5
Nuget Package updates

0.8.0 (Major Project Refactor - Thanks DanielBunting)

Refactor Project Architecture. Thanks DanielBunting
Add Initial Tests. Thanks DanielBunting
Project Code Review. Thanks GioviQ
Revised AuthorizationPolicyProvider. Thanks mobinseven
Server-side Multi-Tenant V.1 (Not working / No UI) - Thanks mobinseven
SQL Server Error Logging with Serilog Thanks np-at
Added Ultramapper for Dto restore / clone. Thanks GioviQ

0.7.0 (Breaking Changes)

.NET Core 3.2 Preview 1- Microsoft & Other Nuget package updates - Program.cs refactored for CSB
MatBlazor 2.1.2
Server-Side Blazor Auth Cookie Issue #138 - Thanks marcotana
Exit from Login dialog #139 - Thanks Oleg26Dev
Focus on Login Form Entry - Thanks responsive-edge
Azure Hosting Wiki and Project update - Thanks soomon
Known Issue with new project structure - Breaks CSB Debugging (shift + alt + d) - Expect fix in .Net Core 3.2 preview 2. Use SSB for debugging.

0.6.1 (No Major Breaking Changes)

.NET Core 3.1.1 - Microsoft Nuget package updates - security patches no code changes
Known Issue with new project structure - Breaks CSB Debugging (shift + alt + d) - Expect fix in .Net Core 3.2 preview 2. Use SSB for debugging.

0.6.0 (Major Breaking Changes)

Dual Mode CSB & SSB View Wiki. Thanks MarkStega
- There are changes to solution structure for Dual Mode. Switching modes can be tricky with the browser cache so if you see something strange use incognito mode or a different browser. Best solution is to pick your version and stick with it, then expect to clear cache when switching. Read the Wiki!
- Known Issue with new project structure - Breaks CSB (shift + alt + d) Debugging - Expect fix in .Net Core 3.2 preview 2 . Use SSB for debugging.

0.5.0

MatBlazor 2.0 Breaking Changes
.NET Core 3.1.0 / v3.1.0-preview4 Blazor Nuget package updates
Admin Roles / Permissions Management. Thanks vd3d
Fix Login EditForm / Double submit of Login. Thanks MarkStega
UserProfile Fixes. Thanks mobinseven
Chrome Cookie updates. Thanks oneparameter

0.4.0

Docker Support. Thanks npraskins & acid12
Fixed IAuditable / ShadowProperties for CreatedOn, CreatedBy, ModifiedOn, ModifiedBy. Thanks acid12
Known Issues:
- Drag and Drop example does not work in FF. Known FF issue.

0.3.2

Identity Server 4 - Authentication with ASP.Net Identity Authorization with Policies
v3.1.0-preview3 / Nuget Package updates
Authorize / Policy Examples on Users Page
Known Issues:
- IAuditable Shadow Properties not getting UserId
- Drag and Drop example does not work in FF. Known FF issue.

0.3.0 - IS4 (Breaking Changes from 0.2.3)

Identity Server 4 First Release - Delete your DB! Thanks to ganmuru
User Profile Store Last Page Visited / Return on Login
.NET Core 3.0.100 / Blazor 3.0.0-preview9.19457.4 update
Known Issues:
- IAuditable Shadow Properties not getting UserId

0.2.3 - .Net Core Authentication / Authorization (Stable Version)

.NET Core 3.0.100 / Blazor 3.0.0-preview9.19457.4 update
Known Issues:
- IAuditable Shadow Properties not getting UserId

0.2.2

Drag and Drop Examples
.NET Core 3.0.0-rc1.19457.4 update
Known Issues:
- IAuditable Shadow Properties not getting UserId

0.2.1

Update to .NET Core 3.0 Preview 9
User Management Screen (CRUD) & User Password Reset - Thanks npraskins
Confirmation Delete Dialog Stylize & Implementation
Known Issues:
- IAuditable Shadow Properties not getting UserId

0.2.0

CRUD Todo List example
Restructure Project Refactor BlazorBoilerplate.Shared for N-Tier Design
Automapper for Client (dto) / Server Models
Removed old Migrations. Recommend to delete your database to start new.
Implement ShadowProperties for Auditable, SoftDelete Interfaces for Models (In Progress)
DB Seed Data
Forum chat and notification system - Thanks ajgoldenwings
Known Issues:
- IAuditable Shadow Properties not getting UserId

0.1.9

Update to SDK 3.0.0-preview8-28405-07
Added IpAddress and UserId to Middleware ApiLogging
Review / Fix VS code Warnings and Information notice. Clean up code.
UserProfile - Beta
MatBlazor 1.6.0

0.1.8

Middleware to log Api Requests and Responses for auditing and debugging. Thanks salslab
Middleware for consistent API Responses and Exception Handling. Thanks proudmonkey
Email Pop3 / IMAP retrieval. Thanks npraskins
Responsive Navigation / Closed / Full / Minified / Minified & Hover effect
Added MatNavMenu PR for MatBlazor - Ver 1.5
Updated demo site for new MatNavMenu and rest of 0.1.8 code

0.1.7

User Profile Management
Refactor Email Settings and API
MatBlazor 1.3.0
Migrate to .NET Core 3.0

0.1.6

Email confirmation on Registration
- Configure Email Configuration in server appsettings.json
- Set "RequireConfirmedEmail" to true in appsettings.json
Forgot Password
- Configure Email Configuration in server appsettings.json
Updated Email Templates for Forgot Password

0.1.5

Added Azure DevOps Pipeline for build status
Added Update Email Templates
Implemented New User Registration Email Template
Implement AuthorizeView for Theme
Breakout Theme Components

0.1.4

Add Mailkit for Email - Future work to add Email Templates
Started API Auth CascadingAuthenticationState / Polices / Claims
Added SQL Server as a DB option

0.1.3

Update to MatBlazor 1.2.1 - Not yet released so using local copy
Update Theme / Drawer minify & close
Fixed Known Issue - UserProfile not loading after login. Thanks nstohler
Secure Pages.
Anonymous Home Page.

0.1.2

Update to SDK 3.0.100-preview6-012264 - Breaking Changes
Update to MatBlazor 1.2
Update Theme
Known Issue - UserProfile not loading after login
Registration Form added Form Validation
Todo Table Fetch from API Example

0.1.1

Updated Theme / Responsive
Added Serilog Log Files

0.1.0

Initial release