diff options
author | houston[bot] <astrobot-houston@users.noreply.github.com> | 2025-08-10 16:30:08 -0700 |
---|---|---|
committer | Elizabeth Hunt <me@liz.coffee> | 2025-08-11 18:30:29 -0700 |
commit | 941cd2cb0ff2b9f40c424f3b36d59064e1e8fdb9 (patch) | |
tree | 43a1306ce3d6419ffbe042c328dbf9e372691198 /README.md | |
download | coffee-941cd2cb0ff2b9f40c424f3b36d59064e1e8fdb9.tar.gz coffee-941cd2cb0ff2b9f40c424f3b36d59064e1e8fdb9.zip |
Initial commit
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..414a13a --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +# Astro Starter Kit: Basics + +```sh +npm create astro@latest -- --template basics +``` + +> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun! + +## 🚀 Project Structure + +Inside of your Astro project, you'll see the following folders and files: + +```text +/ +├── public/ +│ └── favicon.svg +├── src +│ ├── assets +│ │ └── astro.svg +│ ├── components +│ │ └── Welcome.astro +│ ├── 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](https://docs.astro.build/en/basics/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](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat). |