https://github.com/0x0f0f0f/milig.online

https://github.com/0x0f0f0f/milig.online

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/0x0f0f0f/milig.online
• Owner: 0x0f0f0f
• License: mit
• Created: 2024-09-21T17:47:58.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-10-03T14:19:37.000Z (3 months ago)
• Last Synced: 2024-11-24T16:33:58.362Z (about 1 month ago)
• Language: TypeScript
• Size: 3.66 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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:

```bash

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](https://astro.build): A modern static site builder that allows you to write components using familiar web standards like HTML, CSS, and JavaScript.

- [Tailwind CSS](https://tailwindcss.com): A utility-first CSS framework that provides a set of pre-designed styling classes to rapidly build user interfaces.

- [shadcn/ui](https://ui.shadcn.com): 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](https://ui.shadcn.com/docs/installation/astro#thats-it).

> [!NOTE]

> In Astro, an [island](https://docs.astro.build/en/concepts/islands/) refers to any interactive UI component on the page. To add an interactive component like [Accordion](https://ui.shadcn.com/docs/components/accordion), [Dialog](https://ui.shadcn.com/docs/components/dialog) and more you have a couple of solutions available: [Add a Shadcn UI Component - Space Madness](https://spacemadness.dev/docs/add-a-shadcn-ui-component) or [shadcn-ui/ui#2890](https://github.com/AREA44/astro-shadcn-ui-template/issues/66).

For detailed documentation on using Shadcn UI, please visit the [full documentation](https://ui.shadcn.com/docs).

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](https://docs.astro.build/en/core-concepts/framework-components/) to get started.

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

## License

Licensed under the [MIT License](LICENSE).