Skip to content

kystrel/astro-starter

Repository files navigation

Astro Starter

CI Deploy

Personal starter for future Astro projects

Stack

Astro
Astro
Tailwind CSS
Tailwind CSS
DaisyUI
DaisyUI
TypeScript
TypeScript
Biome
Biome
pnpm
pnpm

Configuration

All site-wide settings (name, description, nav links, footer groups, social links, business info, OG image) live in src/config/branding.config.ts. Edit that file to rebrand the starter.

Deploy

The site deploys to GitHub Pages via the CI workflow on every push to master. The live demo is at kystrel.github.io/astro-starter.

Project Structure

/
β”œβ”€β”€ public/
β”‚   β”œβ”€β”€ favicon.ico
β”‚   └── favicon.svg
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ assets/
β”‚   β”‚   └── *.jpg
β”‚   β”œβ”€β”€ components/
β”‚   β”‚   β”œβ”€β”€ BaseHead.astro
β”‚   β”‚   β”œβ”€β”€ Contact.astro
β”‚   β”‚   β”œβ”€β”€ Footer.astro
β”‚   β”‚   β”œβ”€β”€ Header.astro
β”‚   β”‚   β”œβ”€β”€ Hero.astro
β”‚   β”‚   β”œβ”€β”€ Offerings.astro
β”‚   β”‚   β”œβ”€β”€ Reviews.astro
β”‚   β”‚   └── Story.astro
β”‚   β”œβ”€β”€ config/
β”‚   β”‚   └── branding.config.ts
β”‚   β”œβ”€β”€ layouts/
β”‚   β”‚   └── Layout.astro
β”‚   β”œβ”€β”€ pages/
β”‚   β”‚   β”œβ”€β”€ 404.astro
β”‚   β”‚   β”œβ”€β”€ index.astro
β”‚   β”‚   └── robots.txt.ts
β”‚   └── styles/
β”‚       └── global.css
└── package.json

Commands

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

Command Action
pnpm install Installs dependencies
pnpm dev Starts local dev server at localhost:4321
pnpm build Build your production site to ./dist/
pnpm preview Preview your build locally
pnpm check Run TypeScript and Astro diagnostics
pnpm lint Lint with Biome (read-only)
pnpm lint:fix Lint and auto-fix with Biome
pnpm format Auto-format entire repo with Biome

About

πŸš€ Astro starter template

Resources

License

Stars

Watchers

Forks

Contributors