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
- Astro@5.6.1
- CSS (Sass + PostCSS Plugins)
- glob import
- custom media
- TypeScript
- Svelte@5
- minimal setuped linters (eslint, stylelint)
- pretteir
- husky
| 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 |
.
βββ 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