@rezolabs/astro-boilerplate
v0.2.1
Published
> π§βπ **Seasoned astronaut?** Delete this file. Have fun!
Downloads
13
Readme
Astro Starter Kit:
π§βπ Seasoned astronaut? Delete this file. Have fun!
π Project Structure
Inside of your Astro project, you'll see the following folders and files:
/
βββ public/
β βββ favicon.svg
βββ src/
β βββ components/
β β βββ Card.astro
β βββ layouts/
β β βββ Layout.astro
β βββ pages/
β βββ index.astro
βββ package.json
Astro looks for .astro
or .md
files in the src/pages/
directory. Each page is exposed as a route based on its file name.
There's nothing special about src/components/
, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
Any static assets, like images, can be placed in the public/
directory.
π§ 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.