diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 000000000..8b879a01e --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +# Astro Starter Kit: Toolbar App + +```sh +npm create astro@latest -- --template toolbar-app +``` + +[](https://stackblitz.com/github/withastro/astro/tree/latest/examples/toolbar-app) +[](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/toolbar-app) +[](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/toolbar-app/devcontainer.json) + +> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun! + +## 🚀 Project Structure + +Inside of your Astro project, you'll see the following folders and files: + +```text +/ +├── app.ts +├── integration.ts +└── package.json +``` + +The logic of your app is in the appropriately named `app.ts` file. This is where the vast majority of your toolbar app logic will live. + +The `integration.ts` file is a simple Astro integration file that will be used to add your app into the toolbar. + +## 🧞 Commands + +All commands are run from the root of the project, from a terminal: + +| Command | Action | +| :-------------- | :------------------------------------------------- | +| `npm install` | Installs dependencies | +| `npm run dev` | Watch for changes and build your app automatically | +| `npm run build` | Build your app to `./dist/` | + +## 👀 Want to learn more? + +Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat). |