Skip to content

Example Site

example/PeachStateTechnologies.Cms.Plugins.Admin.Example is a plain Cofoundry site used to develop and manually test the plugins in this repo. It's a good reference for wiring your own site up the same way.

What it references

  • Plugins.Admin and Plugins.Imaging.PeachImage, both as local ProjectReferences for fast iteration (PeachStateTechnologies.Cms.Plugins.Admin.Example.csproj). A real consuming site would take a package reference on the published plugin packages instead — see the developer docs overview.
  • Plugins.Storage.R2 is not referenced by the example site (it needs a real Cloudflare R2 account to be useful, which the example site doesn't set up) — see its tests for a look at how it's configured and exercised instead.
  • A companion Angular/Vite project, PeachStateTechnologies.Cms.Plugins.Admin.Example.CalendarEventFields, demonstrating Plugins.Admin's ICustomEntityFieldEditor extension point end-to-end — a custom admin field editor for the CalendarEvents custom entity's start/end timing, built and copied into the site's wwwroot/custom-admin-fields the same way the Admin plugin bundles its own Dashboard/Visual Editor build.

Running it

bash
dotnet run --project example/PeachStateTechnologies.Cms.Plugins.Admin.Example

or use the admin-example launch configuration in .claude/launch.json (port 53784, or https://localhost:53782 per launchSettings.json). First run walks you through Cofoundry's normal setup wizard to create the first user. Set the SQL Server connection string via appsettings.Development.json or user secrets (Cofoundry:Database:ConnectionString) if the default (Server=localhost;Database=PeachStateAdminExample;...) doesn't match your environment.

To work on the Dashboard or Visual Editor front-ends against this site, also start their dev servers from the Admin.Web workspace (npm run start:dashboard / start:visual-editor) alongside it.

Sample content

  • Page templates (Cofoundry/PageTemplates): _General.cshtml (generic page template), CalendarEvent.cshtml and Post.cshtml (custom-entity detail templates for the two custom entities below).
  • Page blocks (Cofoundry/PageBlockTypes/KitchenSink): a block exercising a wide range of field types, useful for testing the Visual Editor's generic block editor and dynamic-form rendering.
  • Custom entities (CustomEntities/): CalendarEvents (includes a custom date-based route and the custom admin field editor mentioned above), Posts (a simple blog-style entity with a custom create-date route), and TestImageItems (a minimal entity for exercising image fields).

These are functional test fixtures and are intentionally left as-is. Documentation screenshots for the user docs use a separate, purpose-built page template and pages with realistic content and stock photography rather than this test data — see the page templates named Showcase* if you're looking for that content specifically.

PeachGrove CMS Documentation