- Do not push any changes to the
main
branch directly. - Work on separate branches and create PRs for merging.
- Use
pnpm
instead of any other package manager like npm or yarn. - Before pushing any changes, make sure to run
pnpm run build
to check for any build errors.
Inside of your Astro project, you'll see the following folders and files:
/
├── public/
├── src/
│ ├── layouts/
│ │ └── Layout.astro
│ └── pages/
│ └── index.astro
└── package.json
To learn more about the folder structure of an Astro project, refer to our guide on project structure.
All commands are run from the root of the project, from a terminal:
Command | Action |
---|---|
pnpm install |
Installs dependencies |
pnpm run dev |
Starts local dev server at localhost:4321 |
pnpm run build |
Build your production site to ./dist/ |
pnpm run preview |
Preview your build locally, before deploying |
pnpm run astro ... |
Run CLI commands like astro add , astro check |
pnpm run astro -- --help |
Get help using the Astro CLI |