the default astro readme is pretty good already so here goes...#
🚀 Project Structure#
Inside of your Astro project, you'll see the following folders and files:
/
├── public/
│ └── public assets go here, like robots.txt. they are not optimised by astro.
├── src
│ ├── assets
│ │ └── these assets are optimised by astro.
│ ├── components
│ │ └── mostly html snippets that multiple pages share, like Audio.astro
│ ├── layouts
│ │ └── layouts that multiple pages use as context for their content, like HomeLayout.astro
│ └── pages
│ └── webpages like index.astro
├── README.md
├── astro.config.mjs
├── package.json
└── tsconfig.json
To learn more about the folder structure of an Astro project, refer to our guide on project structure.
🧞 Commands#
All commands are run from the root of the project, from a terminal:
| Command | Action |
|---|---|
npm install |
Installs dependencies |
npm run dev |
Starts local dev server at localhost:4321 |
npm run dev -- --host |
Exposes local dev server to local network |
npm run build |
Build your production site to ./dist/ |
npm run preview |
Preview your build locally, before deploying |
npm run astro ... |
Run CLI commands like astro add, astro check |
npm run astro -- --help |
Get help using the Astro CLI |
👀 Want to learn more?#
Feel free to check our documentation or jump into our Discord server.