mirror of
https://github.com/withastro/astro.git
synced 2024-12-23 21:53:55 -05:00
425139f912
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> |
||
---|---|---|
.. | ||
demo | ||
packages/my-component | ||
.gitignore | ||
.npmrc | ||
.stackblitzrc | ||
package.json | ||
pnpm-workspace.yaml | ||
README.md | ||
sandbox.config.json |
Astro Starter Kit: Component
npm init astro -- --template 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 or jump into our Discord server.