Skip to content

Repository files navigation

Astro Base

Netlify Status

screenshot

Minimal Astro starter for new projects. MIT licence.

Uses:

πŸš€ Project Structure

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

/
β”œβ”€β”€ astro.config.mjs          # Astro configuration file
β”œβ”€β”€ public/                   # Location of static assets
β”‚   └── favicon.svg
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ assets/               # Location of dynamic assets (eg. images)
β”‚   β”‚   └── screenshot.png
β”‚   β”œβ”€β”€ components/           # Astro components
β”‚   β”‚   └── header.astro
β”‚   β”œβ”€β”€ content/              # Location of content (markdown, data and images)
β”‚   β”‚   └── config.ts
β”‚   β”œβ”€β”€ layouts/              # Location of layouts for pages
β”‚   β”‚   └── Layout.astro
β”‚   └── pages/                # Location of pages
β”‚       └── index.astro
β”œβ”€β”€ package.json
└── tsconfig.json             # Typescript configuration file
└── uno.config.ts             # UnoCSS configuration file

🧞 Commands

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

Command Action
pnpm clean Removes dependencies and output files
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, before deploying
pnpm lint Runs Prettier and ESLint on files in src/
pnpm refresh Updates Astro and other dependencies
pnpm astro ... Run CLI commands like astro add, astro check
pnpm astro -- --help Get help using the Astro CLI

Releases

Sponsor this project

Used by

Contributors

Languages