Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

85 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

grg-kit

A shared resource library for Angular UI applications with themes, components, blocks, and spartan-ng examples.

Prerequisites

  • Node.js: v20.19+ or v22.12+
  • Angular: v21+

Setup

1. Install GRG CLI

npm install -g grg-kit-cli

2. Create Angular Project & Initialize GRG Kit

# Create Angular project first
ng new my-app --style=css
cd my-app

# Initialize GRG Kit
grg init
# or with a specific theme
grg init --theme claude

This installs Tailwind CSS v4, Spartan-NG, theme, and examples into your Angular project.

Quick Start

# Create Angular project
ng new my-app --style=css
cd my-app

# Initialize GRG Kit (installs theme + all components + spartan-ng examples)
grg init

# Or with a specific theme
grg init --theme claude

# Add or switch theme
grg add theme claude

# Add blocks (all files)
grg add block auth
grg add block shell

# Add specific files from a block
grg add block auth login
grg add block shell sidebar

# Add components
grg add component file-upload

# List available resources
grg list

Commands

Command Description
grg init Installs Tailwind v4, Spartan-NG, theme, components, and examples in current Angular project
grg init --theme <name> Same with custom theme
grg add theme <name> Add or switch theme in existing project
grg add block <name> Add all files from a block (auth, shell, settings)
grg add block <name> <files...> Add specific files from a block
grg add block --all Add all blocks
grg add component <name> Add GRG Kit component (file-upload)
grg list List available blocks, themes, and components
grg list blocks List available blocks
grg list themes List available themes
grg list components List available components

Available Resources

Themes

Pre-built theme files with Tailwind CSS v4, spartan-ng integration, and light/dark mode support.

Theme Description
grg-theme Default theme with blue accents
claude Claude-inspired warm tones
clean-slate Minimal grayscale palette
modern-minimal Contemporary minimal design
amber-minimal Warm amber accents
chroma-clinic Professional blue theme for healthcare
bio-lab Fresh green theme for life sciences
pharma-teal Calming teal for pharmaceutical apps
helix-purple DNA-inspired purple for genomics

Blocks

Page blocks that can be added individually.

Block Description
auth Authentication pages: login, register, forgot-password
shell App shell layouts: sidebar, sidebar-footer, topnav, topnav-footer, collapsible, collapsible-footer
settings Settings pages: profile, security, notification, danger-zone
# Add entire block (all files)
grg add block auth
grg add block shell
grg add block settings

# Add specific files only
grg add block auth login                # Just login
grg add block auth login register       # Login and register
grg add block shell sidebar             # Just sidebar shell
grg add block shell topnav topnav-footer  # Topnav variants

# Add all blocks
grg add block --all

Components & Examples

Components and spartan-ng examples are installed automatically via grg init:

  • 1 GRG component (file-upload)
  • 56+ spartan-ng examples (accordion, alert, button, card, dialog, form-field, table, etc.)

AI Assistant Integration

MCP Server (Recommended)

Install the MCP server for automatic AI discovery:

npm install -g grg-kit-mcp-server

Add to your IDE's MCP settings:

{
  "mcpServers": {
    "grg-kit": {
      "command": "grg-mcp-server"
    }
  }
}

Now AI can search and install GRG Kit resources automatically:

  • catalog({ query: "dashboard" }) → finds shell layouts
  • catalog({ query: "signin" }) → finds auth pages
  • catalog({ query: "hospital" }) → finds medical themes

Design System Rules

Generate design system rules for AI assistants:

grg llm-setup

This creates design-system.md rules that help AI follow GRG Kit patterns.

License

MIT

About

Angular UI framework with themes, components, page blocks, CLI, and MCP server

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages