staticwebdev / blazor-starter

A starter template in C# APIs and Blazor for Azure Static Web Apps
219 stars 109 forks source link
azure azure-functions azure-static-web-apps blazor dotnet

Blazor Starter Application

This template contains an example .NET 8 Blazor WebAssembly client application, a .NET 8 C# Azure Functions, and a C# class library with shared code.

Getting Started

  1. Create a repository from the GitHub template and then clone it locally to your machine.

  2. In the Api folder, copy local.settings.example.json to local.settings.json

  3. Continue using either Visual Studio or Visual Studio Code.

Visual Studio 2022

Once you clone the project, open the solution in the latest release of Visual Studio 2022 with the Azure workload installed, and follow these steps:

  1. Right-click on the solution and select Configure Startup Projects....

  2. Select Multiple startup projects and set the following actions for each project:

    • Api - Start
    • Client - Start
    • Shared - None
  3. Press F5 to launch both the client application and the Functions API app.

Visual Studio Code with Azure Static Web Apps CLI for a better development experience (Optional)

  1. Install (or update) the Azure Static Web Apps CLI and Azure Functions Core Tools CLI.

  2. Open the folder in Visual Studio Code.

  3. Delete file Client/wwwroot/appsettings.Development.json

  4. In the VS Code terminal, run the following command to start the Static Web Apps CLI, along with the Blazor WebAssembly client application and the Functions API app:

    In the Client folder, run:

    dotnet run

    In the API folder, run:

    func start

    In another terminal, run:

    swa start http://localhost:5000 --api-location http://localhost:7071

    The Static Web Apps CLI (swa) starts a proxy on port 4280 that will forward static site requests to the Blazor server on port 5000 and requests to the /api endpoint to the Functions server.

  5. Open a browser and navigate to the Static Web Apps CLI's address at http://localhost:4280. You'll be able to access both the client application and the Functions API app in this single address. When you navigate to the "Fetch Data" page, you'll see the data returned by the Functions API app.

  6. Enter Ctrl-C to stop the Static Web Apps CLI.

Template Structure

Deploy to Azure Static Web Apps

This application can be deployed to Azure Static Web Apps, to learn how, check out our quickstart guide.