-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
0 additions
and
53 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,54 +1 @@ | ||
| # Astro Starter Kit: Basics | ||
|
|
||
| ```sh | ||
| npm create astro@latest -- --template basics | ||
| ``` | ||
|
|
||
| [](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics) | ||
| [](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/basics) | ||
| [](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/basics/devcontainer.json) | ||
|
|
||
| > 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun! | ||
|  | ||
|
|
||
| ## 🚀 Project Structure | ||
|
|
||
| Inside of your Astro project, you'll see the following folders and files: | ||
|
|
||
| ```text | ||
| / | ||
| ├── 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: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). |