fgo-ta-com-website/README.md

55 lines
2.3 KiB
Markdown
Raw Permalink Normal View History

2023-07-17 21:34:53 +00:00
# Astro Starter Kit: Basics
2023-07-17 21:06:40 +00:00
```
2023-07-17 21:34:53 +00:00
npm create astro@latest -- --template basics
2023-07-17 21:06:40 +00:00
```
2023-07-17 21:34:53 +00:00
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics)
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/basics)
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/basics/devcontainer.json)
2023-07-17 21:06:40 +00:00
2023-07-17 21:34:53 +00:00
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
2023-07-17 21:06:40 +00:00
2023-07-17 21:34:53 +00:00
![basics](https://user-images.githubusercontent.com/4677417/186188965-73453154-fdec-4d6b-9c34-cb35c248ae5b.png)
2023-07-17 21:06:40 +00:00
2023-07-17 21:34:53 +00:00
## 🚀 Project Structure
2023-07-17 21:06:40 +00:00
2023-07-17 21:34:53 +00:00
Inside of your Astro project, you'll see the following folders and files:
2023-07-17 21:06:40 +00:00
2023-07-17 21:34:53 +00:00
```
/
├── public/
│ └── favicon.svg
├── src/
│ ├── components/
│ │ └── Card.astro
│ ├── layouts/
│ │ └── Layout.astro
│ └── pages/
│ └── index.astro
└── package.json
```
2023-07-17 21:06:40 +00:00
2023-07-17 21:34:53 +00:00
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
2023-07-17 21:06:40 +00:00
2023-07-17 21:34:53 +00:00
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
2023-07-17 21:06:40 +00:00
2023-07-17 21:34:53 +00:00
Any static assets, like images, can be placed in the `public/` directory.
2023-07-17 21:06:40 +00:00
2023-07-17 21:34:53 +00:00
## 🧞 Commands
2023-07-17 21:06:40 +00:00
2023-07-17 21:34:53 +00:00
All commands are run from the root of the project, from a terminal:
2023-07-17 21:06:40 +00:00
2023-07-17 21:34:53 +00:00
| 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 |
2023-07-17 21:06:40 +00:00
2023-07-17 21:34:53 +00:00
## 👀 Want to learn more?
2023-07-17 21:06:40 +00:00
2023-07-17 21:34:53 +00:00
Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).