Welcome to Astro Starter Kit
July 31, 2021 ยท View on GitHub
๐ Project Structure
Inside of your Astro project, you'll see the following folders and files:
/
โโโ public/
โ โโโ assets/
| |-- style/
โ โโโ favicon.ico and other files
โโโ src/
โ โโโ components/
โ โ โโโ BlogPreview.astro, Podcast.astro, and other such components
โ โโโ pages/
โ | โโโ index.astro, and other pages
โ โโโ layouts/
โ โโโ page.astro, and other layout components
โ โโโ data/
โ โโโ static data files (json)
โโโ package.json
Astro looks for .astro or .md files in the src/pages/ directory. Each page is exposed as a route based on its file name.
There's nothing special about src/components/, but that's where any Astro/React/Vue/Svelte/Preact components could be found.
Any static assets, like images, can be placed in the public/ directory.
๐ง Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
|---|---|
npm install | Installs dependencies |
npm run start | Starts local dev server at localhost:3000 |
npm run build | Build your production site to ./dist/ |
๐ Want to learn more?
Feel free to check our documentation or jump into our Discord server.