StellarAdmin.UI 0.100.0

StellarAdmin

<div align="center"> <img src="assets/logo/stellar-admin-logo.svg"> </div>

StellarAdmin.UI is a collection of beautifully designed components based on shadcn/ui which you can use to create CRUD screens in ASP.NET Core MVC and Razor Pages applications.

Note: StellarAdmin is in 0.x, so any release may contain breaking changes. Pin the version you use and read the release notes before you upgrade.

<div align="center">

</div>

Quick start

1. Install package

Install the StellarAdmin.UI NuGet package:

dotnet add package StellarAdmin.UI

2. Register services

Update your Program.cs (or Startup.cs) to register the StellarAdmin services.

using StellarAdmin.UI;

builder.Services.AddStellarAdminUI();

3. Update imports

Update your _ViewImports.cshtml to register the StellarAdmin Tag Helpers and import the StellarAdmin.UI namespace.

@using StellarAdmin.UI
@addTagHelper *, StellarAdmin.UI

4. Link the stylesheet and JavaScript file

Add the StellarAdmin stylesheet and the StellarAdmin JavaScript file to your Razor page or layout.

<!DOCTYPE html>
<html lang="en">
<head>
    ...
    <link rel="stylesheet" href="/_content/StellarAdmin.UI/stellar-admin.css" asp-append-version="true"/>
    <script defer src="/_content/StellarAdmin.UI/stellar-admin.js" asp-append-version="true"></script>
</head>
<body>
    ...
</body>
</html>

5. Start using the Tag Helpers

Start using the StellarAdmin Tag Helpers inside your Razor Pages or MVC Views. For example, the code snippet below adds an alert to your page.

<sa-alert>
    <sa-alert-title>Success! You have configured StellarAdmin correctly.</sa-alert-title>
</sa-alert>

Documentation

Documentation and code examples for all the Tag Helpers can be found online.

Using StellarAdmin with AI agents

The StellarAdmin UI skill teaches agents how to build MVC and Razor Pages UIs in .cshtml files, with component references and workflows for forms, layout, and theming. Its supporting documentation is bundled under skills/stellar-admin-ui/references/. The StellarAdmin theme skill writes theme files from a description or brand colours (--skill stellar-admin-theme). Admin panel guidance is planned separately; see the consumer skills overview.

From your application's project directory, install the skill with Vercel's skills CLI:

npx skills add stellar-admin/stellar-admin --skill stellar-admin-ui

The skill is maintained alongside StellarAdmin; its references may include changes newer than your installed NuGet package. See installation and compatibility for prerequisites, agent selection, and local-checkout installation.

StellarAdmin.UI also supplies the icon services in StellarAdmin.UI.Icons; configure icons, menus, and forms through AddStellarAdminUI(ui => ...).

Resource and admin packages

This repository also contains StellarAdmin (the admin panel: admin shell and resource screens) and StellarAdmin.EntityFrameworkCore (EF Core resources). Both are MIT licensed. Register the admin panel with AddStellarAdmin(admin => ...) and map it with MapStellarAdmin(); it registers StellarAdmin.UI itself, and admin.ConfigureUI(...) configures it. The AdminPlayground demonstrates Identity user and role management through ordinary resources. There is no paid tier. The packages are available from source; their NuGet publication is a separate release step.

The full solution includes a unified docs/DocsSamples app, the website demo exporter, AdminPlayground, and the admin panel and EF Core resource integration tests.

Contributing

Start with contributor guidance and development and verification. This checkout includes the development skills, maintained designs, and plans; no workspace checkout is required. The public website remains a separate repository.