f207c417e0
* feat: add generator property and component * chore: remove `Generator` component * chore: update generator description * chore: include generator in examples * chore: update lockfile * chore: format * fix: do not reference core from server runtime * chore: remove component test Co-authored-by: Nate Moore <nate@astro.build> |
||
|---|---|---|
| .. | ||
| 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 |
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 or jump into our Discord server.