astro/examples/starter
Nate Moore 7063c04dec
Restructure examples (#568)
* rename kitchen sink, pull out react example

* split out the rest of the examples

* align versions

* chore: rename examples

* chore: normalize gitignore

* chore: update package versions

* chore: move framework examples to `framework` namespace

* docs: add README to examples

Co-authored-by: Austin Crim <crim.austin@principal.com>
2021-06-28 10:46:10 -05:00
..
public Fix horizontal scroll for starter template. (#498) 2021-06-18 16:51:47 -07:00
src update discord link 2021-06-08 14:00:13 -07: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 redesign create-astro (#301) 2021-06-08 11:10:56 -04:00
package.json Restructure examples (#568) 2021-06-28 10:46:10 -05:00
README.md update discord link 2021-06-08 14:00:13 -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 run 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.