Skip to content

Latest commit

 

History

History
42 lines (26 loc) · 2.41 KB

README.md

File metadata and controls

42 lines (26 loc) · 2.41 KB
Raw

Astro Shadcn UI Template

This template helps you build apps with Astro, Tailwind CSS, and Shadcn UI.

Getting Started

To get started with this application, make sure you have Node.js v18+ installed on your system. Then, follow these steps:

git clone --depth=1 https://github.com/AREA44/astro-shadcn-ui-template
cd astro-shadcn-ui-template
pnpm install
pnpm dev

Now, you can open your browser and navigate to http://localhost:4321 to see the application running.

Features

  • Astro: A modern static site builder that allows you to write components using familiar web standards like HTML, CSS, and JavaScript.
  • Tailwind CSS: A utility-first CSS framework that provides a set of pre-designed styling classes to rapidly build user interfaces.
  • shadcn/ui: A collection of reusable UI components for building responsive and accessible interfaces.
  • The template includes support for a theme toggle, allowing users to switch between light and dark themes.

How to add components

Shadcn UI is a collection of re-usable components that can be easily integrated into your applications. It is not a component library, but rather a set of components that you can copy and paste into your projects.

To add a new component to your application, please refer to the configuration guide.

Note

In Astro, an island refers to any interactive UI component on the page. To add an interactive component like Accordion, Dialog and more you have a couple of solutions available: Add a Shadcn UI Component - Space Madness or shadcn-ui/ui#2890.

For detailed documentation on using Shadcn UI, please visit the full documentation.

Shadcn UI is primarily built for the React framework. If you are unfamiliar with framework components in Astro, we recommend reading the framework components guide to get started.

Feel free to explore the various components and enhance your application with Shadcn UI!

License

Licensed under the MIT License.