0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2025-04-07 23:41:43 -05:00
The web framework for content-driven websites. ️ Star to support our work!
Find a file
2025-01-13 15:16:01 +00:00
.codesandbox Sync from 6c68269c0e 2025-01-13 15:16:01 +00:00
.vscode Sync from 6c68269c0e 2025-01-13 15:16:01 +00:00
public Sync from 6c68269c0e 2025-01-13 15:16:01 +00:00
src Sync from 6c68269c0e 2025-01-13 15:16:01 +00:00
.gitignore Sync from 6c68269c0e 2025-01-13 15:16:01 +00:00
astro.config.mjs Sync from 6c68269c0e 2025-01-13 15:16:01 +00:00
package.json Sync from 6c68269c0e 2025-01-13 15:16:01 +00:00
README.md Sync from 6c68269c0e 2025-01-13 15:16:01 +00:00
tsconfig.json Sync from 6c68269c0e 2025-01-13 15:16:01 +00:00

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/
│   ├── layouts/
│   │   └── Layout.astro
│   └── pages/
│       └── index.astro
└── package.json

To learn more about the folder structure of an Astro project, refer to our guide on project structure.

🧞 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.