summaryrefslogtreecommitdiff
path: root/examples/deno/README.md
diff options
context:
space:
mode:
authorGravatar Elian ☕️ <elianvancutsem@gmail.com> 2022-06-21 19:07:07 +0200
committerGravatar GitHub <noreply@github.com> 2022-06-21 13:07:07 -0400
commite88b23ea5271369bcd26b0f011cc9146fc258b8c (patch)
treec784e82e3d66674ef924474b409a0c31d0521313 /examples/deno/README.md
parentb4db008e53867386542aa6e74c9649f574045dc9 (diff)
downloadastro-e88b23ea5271369bcd26b0f011cc9146fc258b8c.tar.gz
astro-e88b23ea5271369bcd26b0f011cc9146fc258b8c.tar.zst
astro-e88b23ea5271369bcd26b0f011cc9146fc258b8c.zip
add Astro Deno Example (#3645)
* add Astro Deno Example * add changeset * update pnpm lock Co-authored-by: Dan Jutan <danjutan@gmail.com>
Diffstat (limited to 'examples/deno/README.md')
-rw-r--r--examples/deno/README.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/examples/deno/README.md b/examples/deno/README.md
new file mode 100644
index 000000000..ccbd39d5d
--- /dev/null
+++ b/examples/deno/README.md
@@ -0,0 +1,42 @@
+# Welcome to [Astro](https://astro.build)
+
+[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics)
+
+> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
+
+## 🚀 Project Structure
+
+Inside of your Astro project, you'll see the following folders and files:
+
+```
+/
+├── public/
+│ └── favicon.ico
+├── src/
+│ ├── components/
+│ │ └── Layout.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 or layouts.
+
+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 dev` | Starts local dev server at `localhost:3000` |
+| `npm run build` | Build your production site to `./dist/` |
+| `npm run preview` | Preview your build locally, before deploying |
+
+## 👀 Want to learn more?
+
+Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).