astro/examples/basics
Fred K. Bot 7960fb80a1
[ci] release (next) (#4480)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2022-08-25 17:27:35 -04:00
..
.vscode Feat: new just the basics template (#3206) 2022-04-26 20:37:58 -04:00
public Switch examples favicon to use svg (#4331) 2022-08-17 15:19:04 -05:00
src Switch examples favicon to use svg (#4331) 2022-08-17 15:19:04 -05:00
.gitignore Feat: new just the basics template (#3206) 2022-04-26 20:37:58 -04:00
.npmrc Feat: new just the basics template (#3206) 2022-04-26 20:37:58 -04:00
.stackblitzrc Feat: new just the basics template (#3206) 2022-04-26 20:37:58 -04:00
astro.config.mjs Feat: new just the basics template (#3206) 2022-04-26 20:37:58 -04:00
package.json [ci] release (next) (#4480) 2022-08-25 17:27:35 -04:00
README.md feat: add screenshots to official theme readme files (#4442) 2022-08-24 10:01:01 -04:00
sandbox.config.json Feat: new just the basics template (#3206) 2022-04-26 20:37:58 -04:00
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.