0.0.1 ā€¢ Published 5 months ago

@partykit/site v0.0.1

Weekly downloads
-
License
-
Repository
-
Last release
5 months ago

Astro Starter Kit: Basics

npm create astro@latest -- --template basics

Open in StackBlitz Open with CodeSandbox Open in GitHub Codespaces

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

just-the-basics

šŸš€ 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:

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

šŸ‘€ Want to learn more?

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