mirror of
https://github.com/withastro/astro.git
synced 2024-12-23 21:53:55 -05:00
842ed555d9
* Correcting the link to docs on Just the Basics starter README The link to documentation did not actually go to Docs. Now it does! * fixing all other starter template READMEs with incorrect link to docs |
||
|---|---|---|
| .. | ||
| .vscode | ||
| public | ||
| src/pages | ||
| .gitignore | ||
| .npmrc | ||
| .stackblitzrc | ||
| astro.config.mjs | ||
| package.json | ||
| README.md | ||
| sandbox.config.json | ||
| tsconfig.json | ||
Astro Starter Kit: Minimal
npm init astro -- --template minimal
🧑🚀 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 |
👀 Want to learn more?
Feel free to check our documentation or jump into our Discord server.