How nank1ro/flutter-shadcn-ui works
Project type and purpose
• This is an open-source Flutter UI component library (“shadcn_ui”) that provides reusable, customizable widgets for Flutter apps.
• It ships with:
• A core Dart/Flutter library under lib/src
• A CLI tool (cli/) to scaffold or interact with the library
• A documentation website (docs/) powered by Astro
• A fully working example app (example/)
• A playground/demo app with Firebase integration (playground/)
• A comprehensive test suite (test/)
• CI/CD pipelines (GitHub Actions workflows) and release automation
File structure
• Top-level directories:
• cli: Dart CLI tool, hashing utility, command entrypoint
• docs: static site (Astro, MDX) feeding off component source and content
• example & playground: Flutter apps consuming the library and demonstrating components
• lib/src: the heart of the UI library (components, raw_components, theme, utils)
• test: widget and golden tests covering each component
• Configuration/build artifacts:
• pubspec.yaml at root, cli, example, playground – defines package metadata & dependencies
• GitHub workflows (.github/workflows) for testing, publishing, release automation
• Firebase config in playground for live demo hosting
• Astro config and package.json in docs for doc-site bundling
Extract insights from the README
• Purpose: “Shadcn UI ported in Flutter. Awesome UI components, fully customizable.”
• Components list: accordions, alerts, buttons, dialogs, etc.
• Documentation is published at flutter-shadcn-ui.mariuti.com
• Progress tracking, contribution guidelines, CI badges indicate mature OSS process