tree: eef8d4b623c0c5ec5d85837e6bf2218402a036cf [path history] [tgz]
  1. .vscode/
  2. public/
  3. src/
  4. .gitignore
  5. astro.config.mjs
  6. bun.lockb
  7. package.json
  8. README.md
  9. tailwind.config.mjs
  10. tsconfig.json
sites/main/README.md

Astro Starter Kit: Basics

npm create astro@latest -- --template basics

Open in StackBlitz Open with CodeSandbox Open in GitHub Codespaces

🧑‍🚀 Seasoned astronaut? Delete this file. Have fun!

just-the-basics

🚀 Project Structure

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

/
├── public/
   └── favicon.svg
├── src/
   ├── components/
      └── Card.astro
   ├── layouts/
      └── Layout.astro
   └── pages/
       └── index.astro
└── 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 we like to put any Astro/React/Vue/Svelte/Preact components.

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:

CommandAction
npm installInstalls dependencies
npm run devStarts local dev server at localhost:4321
npm run buildBuild your production site to ./dist/
npm run previewPreview your build locally, before deploying
npm run astro ...Run CLI commands like astro add, astro check
npm run astro -- --helpGet help using the Astro CLI

👀 Want to learn more?

Feel free to check our documentation or jump into our Discord server.