Back to Clerk

Astro Starter Kit: Basics

integration/templates/astro-node/README.md

latest2.3 KB
Original Source

Astro Starter Kit: Basics

sh
npm create astro@latest -- --template basics

šŸ§‘ā€šŸš€ Seasoned astronaut? Delete this file. Have fun!

šŸš€ Project Structure

Inside of your Astro project, you'll see the following folders and files:

text
/
ā”œā”€ā”€ 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:

CommandAction
npm installInstalls dependencies
pnpm devStarts local dev server at localhost:4321
pnpm buildBuild your production site to ./dist/
pnpm previewPreview your build locally, before deploying
pnpm astro ...Run CLI commands like astro add, astro check
pnpm astro -- --helpGet help using the Astro CLI

šŸ‘€ Want to learn more?

Feel free to check our documentation or jump into our Discord server.