astro/examples/minimal/README.md

# Astro Starter Kit: Minimal

```
npm create astro@latest -- --template minimal
```

[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/minimal)
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/minimal)
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/minimal/devcontainer.json)

> 🧑‍🚀 **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:4321`      |
| `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](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
update examples for stackblitz (#1379) 2021-09-16 15:06:22 +00:00			`# Astro Starter Kit: Minimal`

			```
.md only: npm init astro --> npm create astro (#4760) * .md only: npm init astro --> npm create astro For consistency with https://github.com/withastro/docs/pull/360. Docs always use `npm create astro` (never `npm init astro`), README.md files in this repo should do the same. Search: `\b(npm\|yarn\|pnpm) init astro\b` Replace: `$1 create astro` Except for two instances: 1. `packages/create-astro/CHANGELOG.md` -- skipped because changelog. 2. `packages/create-astro/test/create-astro.test.js.skipped` -- skipped, old test disabled in https://github.com/withastro/astro/pull/3168. * docs: add `@latest` to `npm create astro` Co-authored-by: Bjorn Lu <bjorn@bjornlu.com> Co-authored-by: Michael Rienstra <michael@goodmoney.com> 2022-09-16 17:40:06 +00:00			`npm create astro@latest -- --template minimal`
update examples for stackblitz (#1379) 2021-09-16 15:06:22 +00:00			```

update repo URL (#1994) 2021-11-23 22:47:05 +00:00			`[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/minimal)`
Update open with codesandbox link to use synced sandboxes (#6105) 2023-02-03 17:52:11 +00:00			`[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/minimal)`
Fixes example README links to open in codespaces (#6346) 2023-02-23 17:20:19 +00:00			`[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/minimal/devcontainer.json)`
update examples for stackblitz (#1379) 2021-09-16 15:06:22 +00:00
			`> 🧑‍🚀 Seasoned astronaut? Delete this file. Have fun!`

			`## 🚀 Project Structure`
Add minimal template (#1090) 2021-08-15 19:13:58 +00:00
			`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:`

docs: add the right `npm` command regarding `astro --help` for examples' `README.md` files (#6864) 2023-04-18 06:02:40 +00:00			`\| Command \| Action \|`
			`\| :------------------------ \| :----------------------------------------------- \|`
			\| `npm install` \| Installs dependencies \|
feat: change default port to 4321 (#7874) Co-authored-by: Chris Swithinbank <swithinbank@gmail.com> 2023-08-01 15:31:42 +00:00			\| `npm run dev` \| Starts local dev server at `localhost:4321` \|
docs: add the right `npm` command regarding `astro --help` for examples' `README.md` files (#6864) 2023-04-18 06:02:40 +00:00			\| `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 \|
Add minimal template (#1090) 2021-08-15 19:13:58 +00:00
			`## 👀 Want to learn more?`

Correcting the link to docs on Just the Basics starter README (#3482) * Correcting the link to docs on Just the Basics starter README The link to documentation did not actually go to Docs. Now it does! * fixing all other starter template READMEs with incorrect link to docs 2022-05-31 14:11:49 +00:00			`Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).`