README.md (1604B)
1 # Astro Starter Kit: Minimal 2 3 ```sh 4 npm create astro@latest -- --template minimal 5 ``` 6 7 > 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun! 8 9 ## 🚀 Project Structure 10 11 Inside of your Astro project, you'll see the following folders and files: 12 13 ```text 14 / 15 ├── public/ 16 ├── src/ 17 │ └── pages/ 18 │ └── index.astro 19 └── package.json 20 ``` 21 22 Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. 23 24 There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components. 25 26 Any static assets, like images, can be placed in the `public/` directory. 27 28 ## 🧞 Commands 29 30 All commands are run from the root of the project, from a terminal: 31 32 | Command | Action | 33 | :------------------------ | :----------------------------------------------- | 34 | `npm install` | Installs dependencies | 35 | `npm run dev` | Starts local dev server at `localhost:4321` | 36 | `npm run build` | Build your production site to `./dist/` | 37 | `npm run preview` | Preview your build locally, before deploying | 38 | `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | 39 | `npm run astro -- --help` | Get help using the Astro CLI | 40 41 ## 👀 Want to learn more? 42 43 Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).