Go to file
Elizabeth Hunt 7d0611aa8d
initial commit
2023-12-27 14:38:39 -07:00
.vscode initial commit 2023-12-27 14:38:39 -07:00
public initial commit 2023-12-27 14:38:39 -07:00
src initial commit 2023-12-27 14:38:39 -07:00
.dockerignore initial commit 2023-12-27 14:38:39 -07:00
.gitignore initial commit 2023-12-27 14:38:39 -07:00
.prettierrc.mjs initial commit 2023-12-27 14:38:39 -07:00
Dockerfile initial commit 2023-12-27 14:38:39 -07:00
README.md initial commit 2023-12-27 14:38:39 -07:00
astro.config.mjs initial commit 2023-12-27 14:38:39 -07:00
docker-compose.yml initial commit 2023-12-27 14:38:39 -07:00
nginx.conf initial commit 2023-12-27 14:38:39 -07:00
package-lock.json initial commit 2023-12-27 14:38:39 -07:00
package.json initial commit 2023-12-27 14:38:39 -07:00
tsconfig.json initial commit 2023-12-27 14:38:39 -07:00

README.md

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:

Command Action
npm install Installs dependencies
npm run dev Starts local dev server at localhost:4321
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.