summaryrefslogtreecommitdiff
path: root/examples/starter/README.md
diff options
context:
space:
mode:
authorGravatar Fred K. Schott <fkschott@gmail.com> 2021-06-08 08:10:56 -0700
committerGravatar GitHub <noreply@github.com> 2021-06-08 11:10:56 -0400
commit6bca7c83a7e2d62015f45f873b0f69f11b4d902b (patch)
tree5662630e51c6e6e743785d308785cff2e47568f0 /examples/starter/README.md
parent9594447335b7fa15f82c0789f18a3fe02ec20d70 (diff)
downloadastro-6bca7c83a7e2d62015f45f873b0f69f11b4d902b.tar.gz
astro-6bca7c83a7e2d62015f45f873b0f69f11b4d902b.tar.zst
astro-6bca7c83a7e2d62015f45f873b0f69f11b4d902b.zip
redesign create-astro (#301)
* redesign create astro * add changeset * Use npm start * Update the astro version * Adds the changeset Co-authored-by: Fred Schott <fks@Freds-MBP.attlocal.net> Co-authored-by: Matthew Phillips <matthew@skypack.dev>
Diffstat (limited to 'examples/starter/README.md')
-rw-r--r--examples/starter/README.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/examples/starter/README.md b/examples/starter/README.md
new file mode 100644
index 000000000..8565cdbb3
--- /dev/null
+++ b/examples/starter/README.md
@@ -0,0 +1,40 @@
+# Welcome to [Astro](https://astro.build)
+
+> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
+
+## 🚀 Project Structure
+
+Inside of your Astro project, you'll see the following folders and files:
+
+```
+/
+├── public/
+│ ├── robots.txt
+│ └── favicon.ico
+├── src/
+│ ├── components/
+│ │ └── Tour.astro
+│ └── 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 start` | Starts local dev server at `localhost:3000` |
+| `npm run build` | Build your production site to `./dist/` |
+
+## 👀 Want to learn more?
+
+Feel free to check [our documentation](https://github.com/snowpackjs/astro) or jump into our [Discord server](https://discord.gg/EsGdSGen).