Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
2acd779
add
prakhargupta1 Dec 11, 2023
94dbc18
add
prakhargupta1 Jan 4, 2024
336b18f
lint
prakhargupta1 Jan 4, 2024
92cd7aa
edits
prakhargupta1 Jan 4, 2024
d1468e1
add-videos
prakhargupta1 Jan 5, 2024
9696044
add video
prakhargupta1 Jan 9, 2024
fb99668
space
prakhargupta1 Jan 9, 2024
b7c4300
Update docs/pages/blog/2023-toolpad-usage-in-mui.md
prakhargupta1 Jan 10, 2024
1b3f714
add soft line break
prakhargupta1 Jan 18, 2024
245aaca
Merge branch 'blog-how-mui-uses-toolpad' of https://github.com/prakha…
prakhargupta1 Jan 18, 2024
e8ba930
typo
prakhargupta1 Jan 18, 2024
bf96c2a
Apply suggestions from Sam's review
prakhargupta1 Feb 21, 2024
1c3f7b6
more edits
prakhargupta1 Feb 21, 2024
bf6e79e
replace What's next with Conclusion
prakhargupta1 Feb 23, 2024
6034222
add
prakhargupta1 Dec 11, 2023
b6fb13b
add
prakhargupta1 Jan 4, 2024
6de6b76
lint
prakhargupta1 Jan 4, 2024
5265d61
edits
prakhargupta1 Jan 4, 2024
13ceef2
add-videos
prakhargupta1 Jan 5, 2024
003715e
add video
prakhargupta1 Jan 9, 2024
e7324cd
space
prakhargupta1 Jan 9, 2024
2deec73
add soft line break
prakhargupta1 Jan 18, 2024
479cc16
Update docs/pages/blog/2023-toolpad-usage-in-mui.md
prakhargupta1 Jan 10, 2024
d51ef51
typo
prakhargupta1 Jan 18, 2024
be884c1
Apply suggestions from Sam's review
prakhargupta1 Feb 21, 2024
ac033b5
more edits
prakhargupta1 Feb 21, 2024
0d1e329
replace What's next with Conclusion
prakhargupta1 Feb 23, 2024
3fd34bf
polish
oliviertassinari Feb 23, 2024
d4bc1c6
Fix build
oliviertassinari Feb 23, 2024
610f4f7
Sam's review
oliviertassinari Feb 23, 2024
9035ba9
more sam's review
oliviertassinari Feb 23, 2024
b4a4fef
more polish
oliviertassinari Feb 23, 2024
61dac54
more polish
oliviertassinari Feb 23, 2024
bd4faa2
prettier
oliviertassinari Feb 26, 2024
5b33c8b
Merge branch 'blog-how-mui-uses-toolpad' of https://github.com/prakha…
prakhargupta1 Feb 26, 2024
41178e4
update the OG image card
danilo-leal Feb 27, 2024
25522ee
Merge branch 'blog-how-mui-uses-toolpad' of https://github.com/prakha…
prakhargupta1 Feb 28, 2024
5f81c0c
change date to coming Monday
prakhargupta1 Feb 28, 2024
c7669c8
Merge branch 'heads/upstream/master' into pr/40172
Janpot Mar 4, 2024
01bbaf6
Update toolpad-use-cases.js
Janpot Mar 4, 2024
1460deb
Bharat's suggestions
prakhargupta1 Mar 4, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
more edits
  • Loading branch information
prakhargupta1 authored and oliviertassinari committed Feb 26, 2024
commit ac033b5738e8e226373d9f8a095efa5a8998f849
22 changes: 10 additions & 12 deletions docs/pages/blog/2023-toolpad-usage-in-mui.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Toolpad helps full-stack engineers build internal tools quickly.
Internal tools encompass data-intensive CRUD interfaces, analytics dashboards, or custom apps that make teams productive.
Toolpad offers a low-code, GUI-based, code-friendly way of building apps and comes as an npm package that can be imported in an existing codebase.

We've been dogfooding Toolpad at MUI to build our internal tools, and it has proven beneficial for us to easily assemble well-organized, centrally located KPI dashboards and operations apps.
We've been dogfooding Toolpad at MUI to build our internal tools, and it has proven beneficial for us to easily assemble well-organized, centrally located KPI dashboards and operations apps.
In this blog post we'll discuss four such apps, and explain how we used Toolpad to turn our ideas into reality.

<a href="https://tools-public.mui.com/prod/pages/OverviewPage">
Expand All @@ -20,11 +20,11 @@ In this blog post we'll discuss four such apps, and explain how we used Toolpad

## Problems tackled through Toolpad

1. Our internal tooling is easier to use and less prone to errors now; before we built these apps, some of these necessary functions were no more than a set of instructions in a Google doc or on Notion.
2. A user had to log into multiple services to manage their day-to-day chores. Now, one interface does it all.
3. We utilized Pipedream, Metabase, Google Sheets, and other tools to streamline our day-to-day operations.
This meant we had distributed code in multiple places, accessible to only a few.
Now we have everything on GitHub and collaboration is much simpler.
Our internal tooling is easier to use and less prone to errors now; before we built these apps, some of these necessary functions were no more than a set of instructions in a Google doc or on Notion.
A user had to log into multiple services to manage their day-to-day chores. Now, one interface does it all.
We utilized Pipedream, Metabase, Google Sheets, and other tools to streamline our day-to-day operations.
This meant we had distributed code in multiple places, accessible to only a few.
Now we have everything on GitHub and collaboration is much simpler.

Let's delve into four scenarios that Toolpad has successfully addressed:

Expand All @@ -39,11 +39,13 @@ They share their issue through a Priority Support template in our repo where the

[Source code](https://github.com/mui/mui-public/blob/master/tools-public/toolpad/resources/updateMuiPaidSupport.ts)

Here's how we built an app for this:

The [`updateMuiPaidSupport.ts`](https://github.com/mui/mui-public/blob/master/tools-public/toolpad/resources/updateMuiPaidSupport.ts) file hosts all functions that are called from Toolpad.
It uses the [custom function](https://mui.com/toolpad/concepts/custom-functions/) feature and combines GitHub actions, Google Sheets, and Octokit to read and verify user information.
The fetched data is then bound to the UI components.
It took one developer a few hours to build the app.
It uses [page parameters](https://mui.com/toolpad/concepts/page-properties/#page-parameters), [secrets handling](https://mui.com/toolpad/concepts/custom-functions/#secrets-handling), [shell removal](https://mui.com/toolpad/concepts/page-properties/#display-mode), and custom styling as additional features of Toolpad.
This app took one developer just a few hours to build which otherwise would have taken a couple of days.

## 2. Customer support KPI tracker

Expand All @@ -53,10 +55,6 @@ It uses a [custom component](https://mui.com/toolpad/concepts/custom-components/
Based on the metric value, the component shows three color-coded states: Problem (red), Warning (yellow), and OK (green).
Other KPI pages also use this health badge and pre-built Chart components to compare stats, observe trends, and spot anomalies.

<a href="https://tools-public.mui.com/prod/pages/zendeskFirstReply">
<img alt="Zendesk first reply" src="/static/blog/2023-toolpad-usage-in-mui/zendesk.png" loading="lazy" width="2400" height="1394" />
</a>

The video below demonstrates the usage of this app in dev mode:

<video controls width="100%" height="auto" style="contain" alt="zendesk first reply in devmode">
Expand All @@ -68,7 +66,7 @@ We opted for Toolpad since Metabase doesn't support importing data from REST API
This is possible in Google Sheets but it requires writing a lot of JS code, and since we wanted to embed it in a [Notion page](https://www.notion.so/mui-org/KPIs-1ce9658b85ce4628a2a2ed2ae74ff69c#3974cb6ed12b4c5a9013bac63113e3bc), Toolpad was the ideal choice.
Toolpad handles state management and routing, and simplifies query building and data binding, removing the need to write glue code.

You can explore both of the aforementioned apps in dev mode on your device by running the underlying [node app](https://github.com/mui/mui-public/tree/master/tools-public).
You can explore both of the aforementioned apps in dev mode on your device by running the underlying [node app](https://github.com/mui/mui-public/tree/master/tools-public).
The next two apps discussed are internal to MUI.

## 3. Manage overdue invoices
Expand Down
Binary file not shown.