friends-best/README.md

50 lines
1.9 KiB
Markdown
Raw Normal View History

# Welcome to [Astro](https://astro.build)
2021-07-23 16:14:54 +00:00
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics)
2021-07-23 16:14:54 +00:00
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
![basics](https://user-images.githubusercontent.com/4677417/186188965-73453154-fdec-4d6b-9c34-cb35c248ae5b.png)
2021-07-23 16:14:54 +00:00
## 🚀 Project Structure
2021-07-23 16:14:54 +00:00
Inside of your Astro project, you'll see the following folders and files:
2021-07-23 16:14:54 +00:00
```
/
├── public/
│ └── favicon.svg
├── src/
│ ├── components/
│ │ └── Card.astro
│ ├── layouts/
│ │ └── Layout.astro
│ └── pages/
│ └── index.astro
└── package.json
```
2021-07-23 16:14:54 +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.
2021-07-23 16:14:54 +00:00
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
2021-07-23 16:14:54 +00:00
Any static assets, like images, can be placed in the `public/` directory.
2021-07-23 16:14:54 +00:00
## 🧞 Commands
2021-07-23 16:14:54 +00:00
All commands are run from the root of the project, from a terminal:
2021-07-23 16:14:54 +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 preview` |
| `npm run astro --help` | Get help using the Astro CLI |
2021-07-23 16:14:54 +00:00
## 👀 Want to learn more?
2021-07-23 16:14:54 +00:00
Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).