DragonFly.Templates 0.9.7

DragonFly

Headless CMS based on ASP.NET Core and Blazor

Package	Release
DragonFly.Core
DragonFly.AspNetCore
DragonFly.API
DragonFly.Client
DragonFly.BlockField
DragonFly.Proxy
DragonFly.ImageWizard
DragonFly.MongoDB
DragonFly.Identity
DragonFly.ApiKeys
DragonFly.Permissions

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": "MY_MONGODB_USER",
    "Password": "MY_MONGODB_PASSWORD"
  },

DragonFly

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);

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()
                  .AddPermissions();

var app = builder.Build();

//init DragonFly
await app.InitDragonFly();

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

app.UseDragonFly(x => x             
                  .MapImageWizard()
                  .MapApiKey()
                  .MapIdentity()
                  .MapRestApi()
                  .MapPermission());
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.InitDragonFly();
await host.RunAsync();

Docker

version: "2"

services:
  app:
    image: usercode/dragonfly
    container_name: catalog
    restart: always
    networks:
      - default
    volumes:
      - catalog_cache:/cache
    environment: 
      - MongoDB__Database=DragonFly_App
      - MongoDB__Hostname=catalog_db      
      - MongoDB__Username=root
      - MongoDB__Password=YOUR_PASSWORD
      - MongoDB__InitialUsername=admin
      - MongoDB__InitialPassword=Password123
      - AssetCache__Folder=/cache
      - ImageWizard__Key=YOUR_IMAGEWIZARD_KEY
    depends_on:
      - db
  
  db:
    image: mongo:4.4
    container_name: catalog_db
    restart: always
    networks:
      - default
    environment:
      - MONGO_INITDB_ROOT_USERNAME=root
      - MONGO_INITDB_ROOT_PASSWORD=YOUR_PASSWORD      
    volumes:
      - catalog_db:/data/db
      - catalog_configdb:/data/configdb

volumes:
  catalog_db:
    external: true
  catalog_configdb:
    external: true
  catalog_cache:
    external: true