033b70a7f8
* Add Component Example * chore(lint): Prettier fix * nit: improve implementation * nit: Update documentation Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
45 lines
1.5 KiB
Markdown
45 lines
1.5 KiB
Markdown
# Astro Starter Kit: Component
|
|
|
|
```
|
|
npm init astro -- --template component
|
|
```
|
|
|
|
[](https://stackblitz.com/github/withastro/astro/tree/latest/examples/component)
|
|
|
|
> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!
|
|
|
|
## 🚀 Project Structure
|
|
|
|
Inside of your Astro project, you'll see the following folders and files:
|
|
|
|
```
|
|
/
|
|
├── demo/
|
|
│ ├── public/
|
|
│ └── src/
|
|
│ └── pages/
|
|
│ └── index.astro
|
|
└── packages/
|
|
└── my-component/
|
|
├── index.js
|
|
└── package.json
|
|
```
|
|
|
|
This project uses **workspaces** to develop a single package, `@example/my-component`, from `packages/my-component`. It also includes a `demo` Astro site for testing and demonstrating the component.
|
|
|
|
|
|
|
|
## 🧞 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](https://github.com/withastro/astro) or jump into our [Discord server](https://astro.build/chat).
|