This project is a highly extensible, drag-and-drop dashboard builder that allows users to create their own custom components, similar to the Pine Script platform on TradingView.
This document provides a quick guide for both users and new developers. For a deeper understanding of the project's architecture and key concepts, please review the following documents before starting development:
- Architecture Overview: A high-level overview of the system design, including the frontend services and backend responsibilities.
- Glossary of Terms: A dictionary of all key concepts, from high-level entities to specific architectural terms.
- Flowcharts: Visual diagrams of the core application logic.
This guide will walk you through the basic steps to use the editor.
- Create a new page: In the page manager, click "New Page" and give it a name.
- Add a component: In the component library, click on a component (e.g., a default Button). It will appear on the canvas.
- Arrange components: Drag and drop the components on the canvas to arrange them.
- Customize a component: Select a component and use the Properties Panel to change its settings.
- Import a new component: Find or create a
ComponentBlueprintpackaged as a.zipfile. Click the "Import Blueprint" button and select the file. It will then appear in your component library. - Export your project: Click "Export" to save your project as a JSON file.
- Build your project: Click "Build" to generate the static HTML, CSS, and JS files for your dashboard.