https://github.com/smart-ace-designs/astro-starbreeze
An opinionated blank Astro 5 template with built-in support for Starwind UI, Tailwind CSS, prettier, and import aliases.
https://github.com/smart-ace-designs/astro-starbreeze
astro opinionated starwind-ui tailwind-css template
Last synced: about 2 months ago
JSON representation
An opinionated blank Astro 5 template with built-in support for Starwind UI, Tailwind CSS, prettier, and import aliases.
- Host: GitHub
- URL: https://github.com/smart-ace-designs/astro-starbreeze
- Owner: Smart-Ace-Designs
- Created: 2025-03-14T00:17:52.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2025-03-14T15:19:13.000Z (about 2 months ago)
- Last Synced: 2025-03-14T16:27:58.369Z (about 2 months ago)
- Topics: astro, opinionated, starwind-ui, tailwind-css, template
- Language: CSS
- Homepage:
- Size: 8.79 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Astro Template: Star Breeze
**Star Breeze** is an opinionated Astro 5 starter template with built-in support for Starwind UI, Tailwind CSS, Prettier, view transitions, and import aliases.
Using `bunx create-astro@latest` or `npx create-astro@latest` provides everything you need to create a basic Astro application. However, it is missing a few useful items that I found myself manually adding to every Astro project I created. To address this problem, I created this template to automatically include these items plus support for Starwind UI. Additionally, a custom PowerShell function was created to deploy this template and provide some additional functionality that the template cannot.
The template includes:
- [Starwind UI](https://starwind.dev/)
- [Tailwind CSS v4.0](https://tailwindcss.com/)
- [Prettier](https://prettier.io/)
- Astro [View Transitions](https://docs.astro.build/en/guides/view-transitions/)
- Astro [Import Aliases](https://docs.astro.build/en/guides/typescript/#import-aliases)
- A default _MainLayout.astro_ layout file
- A default _starwind.css_ file (required for Starwind UI)
- Default _.vscode_ files to properly handle Tailwind CSS, recommended extensions, and default Prettier formatters
- A blank _index.astro_ page (empty "space")
- The `dev` script set to `"astro dev --open"`
The PowerShell function:
- Creates additional empty folders: _assets_ and _components_
- Blanks out the _README.md_ file
- Runs the `prettier` CLI to provide an intial format of all project files
- Initializes a _Git_ repository
- Automatically navigates to the project folder and peforms an initial install
- Runs `astro update` to update the core Astro packages to the latest versions and runs your preferred package manager (npm or bun) to update the other packages
- Provides an option to launch the site and/or open the project folder with VS Code post deployment
## Deployment Methods
> Using `bunx create-astro@latest` is dependent on __npm__ being present in the path. It is recommended to install __Node.js__ even if __Bun__ is used exclusively.
### bun
```sh
bunx create-astro@latest -- --template smart-ace-designs/astro-starbreeze project-name
```
### npm
```sh
npx create-astro@latest -- --template smart-ace-designs/astro-starbreeze project-name
```
### PowerShell
Add this function to your PowerShell profile or a PowerShell module:
```powershell
function New-AstroProject
{
[CmdletBinding()]
Param
(
[Parameter(Mandatory = $true)] [string]$ProjectName,
[Parameter(Mandatory = $true)] [string]$Location,
[Parameter(Mandatory = $true)] [ValidateSet(
"astro-major-tom",
"astro-moonbase",
"astro-space",
"astro-starbreeze"
)] [string]$Template,
[Parameter(Mandatory = $false)] [switch]$StartApp,
[Parameter(Mandatory = $false)] [switch]$StartCode,
[Parameter(Mandatory = $false)] [ValidateSet(
"bun",
"npm"
)] [string]$PackageManager = "bun"
)
switch ($PackageManager)
{
"bun" {$PackageManagerX = "bunx"}
"npm" {$PackageManagerX = "npx"}
}
Clear-Host
$Message = "Astro Deployment Tool"
$Width = $Host.UI.RawUI.WindowSize.Width
Write-Host
Write-Host ((" " * ($Width - $Message.Length)) + $Message) -ForegroundColor Green
Write-Host ("=" * $Width)
if (Test-Path -Path "$Location\$ProjectName")
{
Write-Host "`nProject folder ($ProjectName) already exists."
Write-Host "Operation cancelled...liftoff failed!"
return
}
Set-Location $Location
& $PackageManagerX create-astro@latest -- --template smart-ace-designs/$($Template) `
--git --no-install $ProjectName
if (!(Test-Path -Path $ProjectName))
{
Write-Host "`nProject folder ($ProjectName) was not created."
Write-Host "Operation cancelled...liftoff failed!"
Write-Host "`nIf using Bun please run `"bun pm cache rm`" to clear the cache and try again."
return
}
Write-Host
Set-Location $ProjectName
switch ($PackageManager)
{
"bun" {& $PackageManager install --no-summary}
"npm" {& $PackageManager install --silent}
}
& $PackageManagerX @astrojs/upgrade
& $PackageManager update --silent --save
if (!(Test-Path -Path "src/components"))
{
[void](New-Item -Name "components" -Path src -ItemType Directory)
}
if (!(Test-Path -Path "src/assets"))
{
[void](New-Item -Name "assets" -Path src -ItemType Directory)
}
Clear-Content -Path "README.md"
Write-Host
& $PackageManagerX prettier . --write --log-level silent
& $PackageManagerX prettier . --check
if ($StartCode -and (Get-Command code -ErrorAction SilentlyContinue)) {code .}
Write-Host
Write-Host ("=" * $Width)
if ($StartApp) {& $PackageManager run dev}
}
```
```sh
New-AstroProject -ProjectName project-name -Location parent-folder -Template astro-starbreeze
```
## Add `Starwind UI` Component
To add a Starwind UI component to your project (example: [Button](https://starwind.dev/docs/components/button/)):
### bun
```sh
bunx starwind@latest add button
```
### npm
```sh
npx starwind@latest add button
```
## Project Structure
Inside of your Astro project you will see the following folders and files:
```text
/
├── .vscode/
│ └── extensions.json
│ └── launch.json
│ └── settings.json
├── public/
│ └── favicon.svg
├── src/
| ├── layouts/
│ └── MainLayout.astro
│ ├── pages/
│ └── index.astro
| ├── styles/
│ └── starwind.css
├── .gitignore
├── .prettierrc.mjs
├── astro.config.mjs
├── package.json
├── README.md
├── starwind.config.json
└── tsconfig.json
```
When deployed with the custom `New-AstroProject` PowerShell function, you will see the following folders and files:
```text
/
├── .vscode/
│ └── extensions.json
│ └── launch.json
│ └── settings.json
├── public/
│ └── favicon.svg
├── src/
| ├── assets/
| ├── components/
| ├── layouts/
│ └── MainLayout.astro
│ ├── pages/
│ └── index.astro
| ├── styles/
│ └── starwind.css
├── .gitignore
├── .prettierrc.mjs
├── astro.config.mjs
├── package.json
├── README.md
├── starwind.config.json
└── tsconfig.json
```