aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorWilliam Hergès <william@herges.fr>2025-08-09 13:31:13 +0200
committerWilliam Hergès <william@herges.fr>2025-08-09 13:31:13 +0200
commitb4ce4105535bc9f276570fadfdfc1a9b28aac699 (patch)
tree0642ac93c5bdf5b7aacce9f69707e92d1757cbaf /README.md
Initial commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md43
1 files changed, 43 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4ced80a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# Astro Starter Kit: Minimal
+
+```sh
+bun create astro@latest -- --template minimal
+```
+
+> πŸ§‘β€πŸš€ **Seasoned astronaut?** Delete this file. Have fun!
+
+## πŸš€ Project Structure
+
+Inside of your Astro project, you'll see the following folders and files:
+
+```text
+/
+β”œβ”€β”€ 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 |
+| :------------------------ | :----------------------------------------------- |
+| `bun install` | Installs dependencies |
+| `bun dev` | Starts local dev server at `localhost:4321` |
+| `bun build` | Build your production site to `./dist/` |
+| `bun preview` | Preview your build locally, before deploying |
+| `bun astro ...` | Run CLI commands like `astro add`, `astro check` |
+| `bun 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).