Developer Guide Overview¶

Ledger Browser is designed with extensibility and customization in mind. You can enhance the GUI functionality by developing custom apps that users can configure and use.

Limitations¶

Currently, applications must be included in the ledger-browser source code and built together with the main application. As the number of apps grows, we may consider transitioning to a more modular (though also more complex) design, allowing apps to be developed in separate packages.

Guidelines¶

• Use React functional components.
• Use TypeScript and adhere to the global Cacti linter requirements.
• Whenever possible, utilize MaterialUI and common UI components.
• Use PageTitle as main page title.
• Use PageTitleWithGoBack as subpage title (it has arrow attached for going back).
• Use NotificationContext for displaying Pop-Up windows with notifications (info, success, error, etc..).
• App routes are defined using react-router-dom.
• Use react-query for fetching data, QueryClientProvider is already available in the application.