0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2024-12-23 21:53:55 -05:00
astro/examples/basics
Fred K. Bot 481e0d1d8a
[ci] release (#4620)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2022-09-06 15:40:15 -04:00
..
.vscode
public Switch examples favicon to use svg (#4331) 2022-08-17 15:19:04 -05:00
src Update templates to avoid devDependencies and :global (#4576) 2022-08-31 16:17:15 -04:00
.gitignore
.npmrc
.stackblitzrc
astro.config.mjs
package.json [ci] release (#4620) 2022-09-06 15:40:15 -04:00
README.md feat: add screenshots to official theme readme files (#4442) 2022-08-24 10:01:01 -04:00
sandbox.config.json
tsconfig.json Add template tsconfigs for users to extend from (#4439) 2022-08-25 15:15:27 -04:00

Welcome to Astro

Open in StackBlitz

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

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:

Command Action
npm install Installs dependencies
npm run dev Starts local dev server at localhost:3000
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 preview
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.