0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2024-12-16 21:46:22 -05:00
astro/examples/minimal
github-actions[bot] 8dcfc1bb15
[ci] release (next) (#2600)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2022-02-16 17:45:49 -06:00
..
public Normalize and cleanup examples projects (#2364) 2022-01-12 10:37:16 -05:00
src/pages Minimize the minimal example (#2508) 2022-01-31 16:28:29 -05:00
.gitignore Normalize and cleanup examples projects (#2364) 2022-01-12 10:37:16 -05:00
.npmrc Add minimal template (#1090) 2021-08-15 14:13:58 -05:00
.stackblitzrc update examples for stackblitz (#1379) 2021-09-16 08:06:22 -07:00
astro.config.mjs Minimize the minimal example (#2508) 2022-01-31 16:28:29 -05:00
package.json [ci] release (next) (#2600) 2022-02-16 17:45:49 -06:00
README.md update repo URL (#1994) 2021-11-23 14:47:05 -08:00
sandbox.config.json Adding CodeSandbox config file to all the "next" examples (#1744) 2021-11-05 10:41:37 -05:00
tsconfig.json Normalize and cleanup examples projects (#2364) 2022-01-12 10:37:16 -05:00

Astro Starter Kit: Minimal

npm init astro -- --template minimal

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/
├── 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

👀 Want to learn more?

Feel free to check our documentation or jump into our Discord server.