summaryrefslogtreecommitdiff
path: root/examples/toolbar-app/README.md
blob: 8b879a01e54a76e846c1183df99fd68bd7570570 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# Astro Starter Kit: Toolbar App

```sh
npm create astro@latest -- --template toolbar-app
```

[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/toolbar-app)
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/toolbar-app)
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](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).