astro/examples/minimal
Houston (Bot) 19fe4cb629
[ci] release (#6414)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2023-03-06 11:30:38 -05:00
..
.vscode [ci] format 2022-03-22 03:16:42 +00:00
public Switch examples favicon to use svg (#4331) 2022-08-17 15:19:04 -05:00
src Fix unintentional change to minimal example (#5214) 2022-10-27 15:39:11 -03:00
.gitignore Add .astro/ to .gitignore in example projects (#5841) 2023-01-12 11:26:13 -05:00
astro.config.mjs Fix astro.config.mjs in minimal example (#5350) 2022-11-10 09:50:29 -06:00
package.json [ci] release (#6414) 2023-03-06 11:30:38 -05:00
README.md Fixes example README links to open in codespaces (#6346) 2023-02-23 11:20:19 -06:00
sandbox.config.json Adding CodeSandbox config file to all the "next" examples (#1744) 2021-11-05 10:41:37 -05:00
tsconfig.json Add template tsconfigs for users to extend from (#4439) 2022-08-25 15:15:27 -04:00

Astro Starter Kit: Minimal

npm create astro@latest -- --template minimal

Open in StackBlitz Open with CodeSandbox Open in GitHub Codespaces

🧑‍🚀 Seasoned astronaut? Delete this file. Have fun!

🚀 Project Structure

Inside of your Astro project, you'll see the following folders and files:

/
├── public/
├── src/
│   └── 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 check
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.