HopFrame/docs/usage.md

HopFrame Usage

There are two different versions of HopFrame, either the Web API version or the full Blazor web version.

Ho to use the Web API version

1. Add the HopFrame.Api library to your project:

   dotnet add package HopFrame.Api
   

2. Create a DbContext that inherits the HopDbContext and add a data source

   public class DatabaseContext : HopDbContextBase {
       protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder) {
           base.OnConfiguring(optionsBuilder);
   
           optionsBuilder.UseSqlite("...");
       }
   }
   

3. Add the DbContext and HopFrame to your services

   builder.Services.AddDbContext<DatabaseContext>();
   builder.Services.AddHopFrame<DatabaseContext>();
   

How to use the Blazor API

1. Add the HopFrame.Web library to your project

   dotnet add package HopFrame.Web
   

2. Create a DbContext that inherits the HopDbContext and add a data source

   public class DatabaseContext : HopDbContextBase {
       protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder) {
           base.OnConfiguring(optionsBuilder);
   
           optionsBuilder.UseSqlite("...");
       }
   }
   

3. Add the DbContext and HopFrame to your services

   builder.Services.AddDbContext<DatabaseContext>();
   builder.Services.AddHopFrame<DatabaseContext>();
   

4. Add the authentication middleware to your app

   app.UseMiddleware<AuthMiddleware>();
   

5. Add the HopFrame pages to your Razor components

   app.MapRazorComponents<App>()
    .AddHopFrameAdminPages()
    .AddInteractiveServerRenderMode();