astro/examples/starter
github-actions[bot] b54c01bf66
Version Packages (#1064)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2021-08-11 15:01:00 -07:00
..
public [ci] yarn format 2021-07-20 04:07:49 +00:00
src Reduce meta viewport tag (#1006) 2021-08-04 08:30:58 -04:00
.gitignore redesign create-astro (#301) 2021-06-08 11:10:56 -04:00
.npmrc force pnpm to hoist packages inside astro #342 #190 (#530) 2021-06-24 09:48:25 -04:00
astro.config.mjs Add framework-specific prompt and setup to create-astro (#620) 2021-07-07 14:52:44 -05:00
package.json Version Packages (#1064) 2021-08-11 15:01:00 -07:00
README.md replace npm run start with npm start (#791) 2021-07-21 07:09:44 -07:00

Welcome to Astro

🧑‍🚀 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 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.