0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2024-12-16 21:46:22 -05:00
astro/examples/basics
Fred K. Bot 4d29163d11
[ci] release (#4197)
* [ci] release

* Update CHANGELOG.md

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com>
2022-08-08 18:10:55 -05:00
..
.vscode Feat: new just the basics template (#3206) 2022-04-26 20:37:58 -04:00
public Feat: new just the basics template (#3206) 2022-04-26 20:37:58 -04:00
src Add Astro.generator (#4012) 2022-08-08 12:34:05 -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 (#4197) 2022-08-08 18:10:55 -05:00
README.md update example scripts (#4098) 2022-08-05 21:36:23 -07:00
sandbox.config.json Feat: new just the basics template (#3206) 2022-04-26 20:37:58 -04:00
tsconfig.json Move types to a .d.ts file inside examples projects (#4171) 2022-08-05 17:46:52 -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/
│   └── favicon.ico
├── src/
│   ├── components/
│   │   └── 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 or layouts.

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.