Skip to content

Commit 6dedfbd

Browse files
committed
end of Apps Quickstart
1 parent d9eecb0 commit 6dedfbd

File tree

4 files changed

+26
-11
lines changed

4 files changed

+26
-11
lines changed
Loading

docs/getting_started/7_apps_quickstart/index.md

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Although Windmill provides **auto-generated UIs to scripts and flows**, you can
77
Windmill applications are customized UIs to interact with datasources (web, internal, data providers, etc). They are a great way to have non-technical users interact with custom-made workflows.
88

99
In short, what you need to remember about apps:
10-
- they work on a **drag-and-drop basis**
10+
- they work on a **what-you-see-is-what-you-get basis**
1111
- you can connect apps and components to **datasources**
1212
- components can be **empowered by Windmill [scripts](https://docs.windmill.dev/docs/getting_started/scripts_quickstart/typescript)**
1313

@@ -53,26 +53,27 @@ Check out all of our components at [this page](https://docs.windmill.dev/docs/ap
5353

5454
### Empower components with scripts
5555

56-
The beauty of Windmill App editor is the integrations of scripts & workflows to components. On the bottom of the app editor, you can find the **[Runnable](https://docs.windmill.dev/docs/apps/app-runnable)** editor. It allows you to create, edit or manage the scripts or flows linked to components (Runnable), and background scripts.
56+
The beauty of Windmill App editor is the integrations of scripts & workflows to components. On the bottom of the app editor, you can find the **[Runnable](https://docs.windmill.dev/docs/apps/app-runnable)** editor. It allows you to create, edit or manage the scripts or flows linked to components (Runnables), and background scripts.
5757

5858
![Runnable editor](./apps_runnables.png)
5959

6060
:::tip Add a script to a component
6161

62+
The following video showcases how to call a script either from workspace/hub or add it directly inline.
63+
<br/>
64+
6265
<video
6366
className="border-2 rounded-xl object-cover w-full h-full"
6467
autoPlay
6568
loop
6669
controls
6770
id="main-video"
68-
src="./script_and_flows_components.mp4"
71+
src="/videos/script_and_flows_components.mp4"
6972
/>
7073

71-
<!-- Don't know yet how to load a video -->
72-
7374
:::
7475

75-
The **[Ouputs](https://docs.windmill.dev/docs/apps/app_outputs)** of each component can be found on the left side menu. Each of them is associated with a component (you can see the component id).
76+
The **[Ouputs](https://docs.windmill.dev/docs/apps/app_outputs)** of each component can be found on the left side menu. Each of them is associated with a component (see the component id).
7677

7778
![Apps outputs](./apps_ouputs.png)
7879

@@ -82,15 +83,15 @@ The **[Ouputs](https://docs.windmill.dev/docs/apps/app_outputs)** of each compon
8283
![Connect inputs to outputs](./connect_inputs_outputs.png)
8384

8485

85-
At any time, have a look at your app's **Inputs** associated with each component on the dedicated `App inputs` menu.
86+
At any time, have a look at your app's **Inputs** associated with each component on the dedicated `App inputs` tab.
8687

8788
![Apps inputs](./apps_inputs.png)
8889

8990

9091

9192
### Tailor the look of your app
9293

93-
At the **component level**, on the `Settings` tab, configure the style of each component (color, size, label, etc.)
94+
At the **component level**, on the `Settings` tab, configure the style of each component (color, size, label, etc.) either directly on boxes or in Custom CSS (on the `Settings` tab).
9495

9596
![Cutomize components](./customize_component.png)
9697

@@ -99,7 +100,21 @@ At the **app level**, you can give a harmonized style to your app with CSS. On t
99100

100101
![Customize CSS](./customize_css.png)
101102

103+
### Time to test
104+
105+
While building you app, you can try each component clicking on refresh button.
106+
107+
You can do a refresh all for the whole app with the refesh button on top of the canvas, or even schedule automatic refesh.
108+
109+
![Refresh app](./refresh_app.png)
110+
111+
For possible bugs, there is a `Debug Runs` tab to review past runs with details per component.
112+
113+
![Debug runs](./debug_runs.png)
114+
115+
116+
### Then what?
117+
118+
When you're done with the editing of your app, `Save` the current version to the relevant users/folders with a proper and explicit name.
102119

103-
- Debug runs
104-
- Publish & save
105-
- JSON & Hub compatible JSON
120+
Once it's saved, it's ready to use! You can also `Publish` it, or even `Publish to Hub` and export it in JSON or Hub compatible JSON from the `` tab.
Loading

0 commit comments

Comments
 (0)