Skip to content
/ astro-basic-template Public template

πŸš€ Astro basic template provides a basic structure and config for website development.

Notifications You must be signed in to change notification settings

uuki/astro-basic-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

15 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Astro basic template

License

This boilerplate is a basic web development setup and built-in support for linting and prettier using husky, making it easy to use for various projects.

Thanks to withastro/astro

lighthouse

✨ Features

  • Astro@5.6.1
  • CSS (Sass + PostCSS Plugins)
    • glob import
    • custom media
  • TypeScript
  • Svelte@5
  • minimal setuped linters (eslint, stylelint)
  • pretteir
  • husky

🧞 Commands

Command Action
pnpm install Installs dependencies
pnpm dev Starts local dev server at http://localhost:4321
pnpm build Build your production site to ./dist/
pnpm preview Preview your build locally, before deploying
pnpm astro ... Run CLI commands like astro add, astro preview
pnpm astro --help Get help using the Astro CLI

πŸš€ Project Structure

.
β”œβ”€β”€ README.md
β”œβ”€β”€ astro.config.mjs
β”œβ”€β”€ lint-staged.config.js # for husky
β”œβ”€β”€ package.json
β”œβ”€β”€ public
β”‚Β Β  └── favicon.svg # πŸš€
β”œβ”€β”€ src
β”‚Β Β  β”œβ”€β”€ assets # site assets
β”‚Β Β  β”‚Β Β  └── img
β”‚Β Β  β”œβ”€β”€ components # astro templates
β”‚Β Β  β”œβ”€β”€ data # static data for templates
β”‚Β Β  β”‚Β Β  β”œβ”€β”€ config.yml # site config
β”‚Β Β  β”‚Β Β  └── meta.yml
β”‚Β Β  β”œβ”€β”€ js
β”‚Β Β  β”‚Β Β  └── app.ts
β”‚Β Β  β”œβ”€β”€ layouts
β”‚Β Β  β”‚Β Β  β”œβ”€β”€ App.astro
β”‚Β Β  β”‚Β Β  └── Document.astro
β”‚Β Β  β”œβ”€β”€ pages
β”‚Β Β  β”‚Β Β  β”œβ”€β”€ index.astro
β”‚Β Β  β”‚Β Β  └── index.module.scss
β”‚Β Β  β”œβ”€β”€ styles # only global styles *e.g. reset, base, breakpoints, variables, utility...
β”‚Β Β  β”‚Β Β  β”œβ”€β”€ foundations
β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ base.scss
β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ custom-media.scss
β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ mixins
β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ reset.scss
β”‚Β Β  β”‚Β Β  β”‚Β Β  └── variables
β”‚Β Β  β”‚Β Β  └── style.scss
β”‚Β Β  β”œβ”€β”€ types
β”‚Β Β  β”‚Β Β  β”œβ”€β”€ astro.d.ts # custom type for astro components
β”‚Β Β  β”‚Β Β  └── declaration.d.ts
β”‚Β Β  └── utils
β”‚Β Β      └── meta.ts
└── tsconfig.json

About

πŸš€ Astro basic template provides a basic structure and config for website development.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published