0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2024-12-16 21:46:22 -05:00
astro/examples/starter
Fred K. Bot 0f73ece26b
[ci] release (#3783)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2022-07-01 03:09:17 +00:00
..
.vscode [ci] format 2022-03-22 03:16:42 +00:00
public update starter template (#3109) 2022-04-14 14:09:42 -05:00
src [ci] format 2022-04-14 19:10:28 +00:00
.gitignore refactor(vercel): Build Output API v3 (#3216) 2022-05-11 15:10:38 -06:00
.npmrc
.stackblitzrc
astro.config.mjs
package.json [ci] release (#3783) 2022-07-01 03:09:17 +00:00
README.md Correcting the link to docs on Just the Basics starter README (#3482) 2022-05-31 10:11:49 -04:00
sandbox.config.json
tsconfig.json Update example tsconfig (#3107) 2022-04-28 11:42:55 -04:00

Welcome to Astro

Open in StackBlitz

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

🚀 Project Structure

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

/
├── public/
│   ├── robots.txt
│   └── favicon.ico
├── src/
│   ├── components/
│   │   └── Tour.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

👀 Want to learn more?

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