0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2024-12-23 21:53:55 -05:00
astro/examples/starter
github-actions[bot] 983bf72aa1
[ci] release (#2340)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2022-01-12 11:30:01 -05:00
..
public move styles to src (#2003) 2021-11-24 11:10:12 -08:00
src Use accessible indentation (#2253) 2021-12-22 16:11:05 -05:00
.gitignore Normalize and cleanup examples projects (#2364) 2022-01-12 10:37:16 -05:00
.npmrc force pnpm to hoist packages inside astro #342 #190 (#530) 2021-06-24 09:48:25 -04:00
.stackblitzrc update examples for stackblitz (#1379) 2021-09-16 08:06:22 -07:00
astro.config.mjs Use accessible indentation (#2253) 2021-12-22 16:11:05 -05:00
package.json [ci] release (#2340) 2022-01-12 11:30:01 -05:00
README.md update repo URL (#1994) 2021-11-23 14:47:05 -08:00
sandbox.config.json CodeSandbox-izing via template override (#1167) 2021-08-20 12:33:15 -07:00
tsconfig.json Adjust TSConfig example files to include compilerOptions (#2278) 2021-12-26 22:39:30 -05: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.