👁 Image
DragonFly.Proxy 0.9.20

DragonFly - Headless CMS based on ASP.NET Core and Blazor

👁 License: MIT

Getting started

Prerequisites

• .NET 7.0 SDK
• Visual Studio 2022
• MongoDB instance

Create a new project from template

To use the project template you need first to download and install it from NuGet.

dotnet new install DragonFly.Templates

After this you can create the project with:

dotnet new DragonFly

If you have a remote MongoDB instance, you need to add some appsettings:

"MongoDB": {
 "Hostname": "localhost",
 "Database": "DragonFly_App",
 "Port": 27017,
 "Username": "",
 "Password": ""
 },

DragonFly

👁 grafik

Supported fields

• StringField
• FloatField
• BoolField
• AssetField
• ReferenceField
• ComponentField
• ArrayField
• DateField
• IntegerField
• ColorField
• GeoLocationField
• SlugField
• XmlField
• HtmlField
• BlockField (HeadingBlock, TextBlock, HtmlBlock, CodeBlock, ContainerBlock, ColumnBlock, AssetBlock, ReferenceBlock, GridBlock,..)

How to create new content schema and content item

IContentStorage contentStorage = ...;//use MongoStorage or ClientContentService (http client)

//create brand schema
ContentSchema schemaBrand = new ContentSchema("Brand")
 .AddString("Name")
 .AddSlug("Slug")
 .AddTextArea("Description");

//Define schema for product
ContentSchema schemaProduct = new ContentSchema("Product")
 .AddReference("Brand")
 .AddString("Name", options => options.IsRequired = true)
 .AddSlug("Slug")
 .AddBool("IsAvailable", options => options.DefaultValue = true)
 .AddFloat("Price")
 .AddTextArea("Description", options => options.MaxLength = 255)
 .AddArray("Attributes", options => options
 .AddString("Name")
 .AddString("Value"));

await contentStorage.CreateAsync(schemaProduct);

//create product by schema
ContentItem contentProduct = schemaProduct
 .CreateContent()
 .SetReference("Brand", new ContentItem(Guid.Parse(""), schemaBrand))
 .SetString("Name", "ProductA")
 .SetBool("IsAvailable", true)
 .SetFloat("Price", 9.99)
 .SetTextArea("Description", "...")
 .AddArrayItem("Attributes", schemaProduct, item => item
 .SetString("Name", "Size")
 .SetString("Value", "M"));

await contentStorage.CreateAsync(contentProduct);

Create typed content

[ContentItem("BlogPost")]
public class BlogPostModel : EntityPageModel
{
 [DateField(Required = true)]
 public virtual DateTime? Date { get; set; }

 [StringField(Required = true, Searchable = true, ListField = true, MinLength = 8, MaxLength = 512)]
 public virtual string Title { get; set; }

 [TextField]
 public virtual string Description { get; set; }

 [SlugField(Required = true, Index = true)]
 public virtual string Slug { get; set; }

 [AssetField(ListField = true, ShowPreview = true)]
 public virtual AssetField Image { get; set; }

 [BlockField]
 public virtual BlockField MainContent { get; set; }
}

Register typed content

builder.Services.AddDragonFly()
 .AddProxy(x => x.AddType<BlogPostModel>()); 

Use queries for typed content

//get first item
var first = await ContentStorage.FirstOrDefaultAsync<BlogPostModel>(x => x
 .SlugQuery(x => x.Slug, slug));

//get all items
var result = await ContentStorage.QueryAsync<BlogPostModel>(x => x
 .Published(true)
 .Top(10)
 .SlugQuery(x => x.Slug, slug));

BackgroundTask

For long running jobs you can use the BackgroundTaskManager.

IBackgroundTaskManager taskManager = app.Services.GetRequiredService<IBackgroundTaskManager>();
taskManager.Start("Test", async ctx => await Task.Delay(TimeSpan.FromSeconds(60), ctx.CancellationToken));

DragonFly.AspNetCore

builder.Services.Configure<DragonFlyOptions>(Configuration.GetSection("General"));
builder.Services.Configure<MongoDbOptions>(Configuration.GetSection("MongoDB"));

//add DragonFly services
builder.Services.AddDragonFly()
 .AddImageWizard()
 .AddRestApi()
 .AddMongoDbStorage()
 .AddMongoDbIdentity()
 .AddBlockField()
 .AddApiKeys();

var app = builder.Build();

//init DragonFly
await app.InitDragonFlyAsync();

if (env.IsDevelopment())
{
 app.UseDeveloperExceptionPage();
 app.UseWebAssemblyDebugging();
}

app.UseDragonFly(x => x 
 .MapImageWizard()
 .MapApiKey()
 .MapIdentity()
 .MapRestApi());
app.UseDragonFlyManager();
app.UseRouting();
app.Run();

DragonFly.Client (Blazor)

var builder = WebAssemblyHostBuilder.CreateDefault(args);
builder.RootComponents.Add<DragonFly.App.Client.App>("app");

//Register DragonFly components
builder.AddDragonFly()
 .AddRestApi()
 .AddBlockField()
 .AddIdentity()
 .AddApiKeys();

WebAssemblyHost host = builder.Build();

await host.InitDragonFlyAsync();
await host.RunAsync();