Go to file
roryjshelton 80aae172da text size 2023-04-27 17:44:39 -07:00
public initial 2023-04-27 16:33:58 -07:00
src text size 2023-04-27 17:44:39 -07:00
.DS_Store add 2023-04-27 16:32:15 -07:00
.gitignore initial commit 2023-04-22 01:21:49 -07:00
README.md initial 2023-04-27 16:33:58 -07:00
astro.config.mjs header -> client:load 2023-04-27 17:40:05 -07:00
package-lock.json header -> client:load 2023-04-27 17:40:05 -07:00
package.json header -> client:load 2023-04-27 17:40:05 -07:00
tailwind.config.cjs initial 2023-04-27 16:33:58 -07:00
tsconfig.json initial 2023-04-27 16:33:58 -07:00

README.md

Astro Starter Kit: Minimal

npm create astro@latest -- --template minimal

Open in StackBlitz Open with CodeSandbox Open in GitHub Codespaces

🧑‍🚀 Seasoned astronaut? Delete this file. Have fun!

🚀 Project Structure

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

/
├── public/
├── src/
│   └── 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.