https://github.com/pryority/astroplate

An Astro template that uses shadcn/ui
https://github.com/pryority/astroplate

astro bun shadcn-ui tailwindcss template

Last synced: about 2 months ago
JSON representation

An Astro template that uses shadcn/ui

• Host: GitHub
• URL: https://github.com/pryority/astroplate
• Owner: Pryority
• Created: 2023-12-15T19:59:23.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-27T15:13:49.000Z (11 months ago)
• Last Synced: 2024-04-14T02:11:16.451Z (9 months ago)
• Topics: astro, bun, shadcn-ui, tailwindcss, template
• Language: TypeScript
• Homepage:
• Size: 1.06 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Astroplate

An Astro template that uses shadcn/ui.

![Astroplate Demo Image](./public/astroplate-demo.png)

![Astroplate iPad Mockup](./public/astroplate-ipad-mockup.png)

![Astroplate iPhone Mockup](./public/astroplate-iphone-mockup.png)

## 🚀 Project Structure

Inside of your Astro project, you'll see the following folders and files:

```text

/

├── README.md

├── astro.config.mjs

├── bun.lockb

├── components.json

├── package.json

├── public

│   └── favicon.svg

├── src

│   ├── components

│   │   ├── CartDrawer.tsx

│   │   ├── ContactCard.tsx

│   │   ├── Header

│   │   │   ├── Header.astro

│   │   │   ├── MenuBar.tsx

│   │   │   ├── MobileMenuBar.tsx

│   │   │   ├── ModeToggle.tsx

│   │   │   └── NavDropdownItem.tsx

│   │   └── ui

│   │       ├── accordion.tsx

│   │       ├── button.tsx

│   │       ├── card.tsx

│   │       ├── drawer.tsx

│   │       ├── dropdown-menu.tsx

│   │       ├── input.tsx

│   │       ├── label.tsx

│   │       ├── navigation-menu.tsx

│   │       ├── scroll-area.tsx

│   │       ├── select.tsx

│   │       ├── sheet.tsx

│   │       └── textarea.tsx

│   ├── env.d.ts

│   ├── layouts

│   │   ├── PageHeader.astro

│   │   └── Root.astro

│   ├── lib

│   │   ├── constants.ts

│   │   └── utils.ts

│   ├── pages

│   │   ├── about.astro

│   │   ├── contact.astro

│   │   ├── index.astro

│   │   ├── shop

│   │   │   └── [country].astro

│   │   └── shop.astro

│   └── styles

│       └── globals.css

├── tailwind.config.mjs

└── tsconfig.json

```

Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.

There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.

Any static assets, like images, can be placed in the `public/` directory.

## 🧞 Commands

All commands are run from the root of the project, from a terminal:

| Command                       | Action                                           |

| :---------------------------- | :----------------------------------------------- |

| `bun install`                 | Installs dependencies                            |

| `bunx --bun astro dev`        | Starts local dev server at `localhost:4321`      |

| `bunx --bun astro build`      | Build your production site to `./dist/`          |

| `bunx --bun astro preview`    | Preview your build locally, before deploying     |

| `bunx --bun astro`            | Run CLI commands like `astro add`, `astro check` |

| `bunx --bun astro -- --help`  | Get help using the Astro CLI                     |

## 👀 Want to learn more?

Feel free to check [the Astro documentation](https://docs.astro.build) or jump into the [Astro Discord server](https://astro.build/chat).