├── README.md
└── setup.md
/README.md:
--------------------------------------------------------------------------------
1 | # Builder.io Desktop App
2 |
3 | > **Note**: This is a temporary placeholder repository for alpha releases of the Builder.io native app.
4 |
5 | ## Quick Download
6 |
7 | **Direct Download Links:**
8 | - 🍎 **macOS (Apple Silicon)**: [Download Builder.io-0.2.27-arm64.dmg](https://github.com/BuilderIO/native-app-distribution/releases/download/v0.2.27-alpha/Builder.io-0.2.27-arm64.dmg)
9 | - 🍎 **macOS (Intel)**: [Download Builder.io-0.2.27.dmg](https://github.com/BuilderIO/native-app-distribution/releases/download/v0.2.27-alpha/Builder.io-0.2.27.dmg)
10 | - 🪟 **Windows**: [Download BuilderInstaller.exe](https://github.com/BuilderIO/native-app-distribution/releases/download/v0.2.27-alpha/BuilderInstaller.exe)
11 |
12 | ## Installation via GitHub CLI (Optional)
13 |
14 | If you prefer using GitHub CLI:
15 |
16 | ```bash
17 | # Install GitHub CLI first: https://cli.github.com/
18 | gh auth login
19 | ```
20 |
21 | ### macOS (Apple Silicon - M1/M2/M3)
22 | ```bash
23 | gh release download "v0.2.27-alpha" --repo "BuilderIO/native-app-distribution" --pattern "Builder.io-0.2.27-arm64.dmg"
24 | open Builder.io-0.2.27-arm64.dmg
25 | ```
26 |
27 | ### macOS (Intel)
28 | ```bash
29 | gh release download "v0.2.27-alpha" --repo "BuilderIO/native-app-distribution" --pattern "Builder.io-0.2.27.dmg"
30 | open Builder.io-0.2.27.dmg
31 | ```
32 |
33 | ### Windows
34 | ```bash
35 | gh release download "v0.2.27-alpha" --repo "BuilderIO/native-app-distribution" --pattern "BuilderInstaller.exe"
36 | ./"BuilderInstaller.exe"
37 | ```
38 |
39 | ---
40 |
41 | *Made with ❤️ by the Builder.io team*
42 |
--------------------------------------------------------------------------------
/setup.md:
--------------------------------------------------------------------------------
1 | # Using Fusion Projects in Builder Desktop
2 |
3 | Builder Desktop provides multiple options for running Fusion projects, giving you flexibility and performance advantages over the web-based application.
4 |
5 | ## Execution Environment Options
6 |
7 | Builder Desktop offers three ways to run your Fusion projects:
8 |
9 | ### 1. Cloud Containers
10 | Run fusion projects in cloud containers, same as our web app.
11 |
12 | ### 2. Local Machine (Container-less)
13 |
14 | Run Fusion projects directly on your local machine without containerization.
15 |
16 | **Benefits:**
17 | - Fastest performance and startup times
18 | - Direct access to your local development environment
19 | - No additional software requirements
20 | - Best for rapid development and iteration
21 |
22 | **Requirements:**
23 | - May require additional tools depending on your project
24 | - These are typically already installed on most development machines
25 |
26 | ### 4. Local Containers (Docker)
27 |
28 | Run Fusion projects in isolated local Podman containers.
29 |
30 | **Benefits:**
31 | - Good isolation between projects
32 | - Consistent environment across different machines
33 | - Local control over the container environment
34 |
35 |
36 |
37 | ## Configuration
38 |
39 | To change your Fusion execution environment:
40 |
41 | 1. Open Builder Desktop
42 | 2. Go to **Settings** from the left sidebar → scroll all the way down and click **Advanced Settings** → **Labs**
43 | 4. Select your preferred option:
44 |
45 |
46 |
47 |
48 | ## Getting Started
49 |
50 | 1. **Install [Builder Desktop](https://github.com/BuilderIO/native-app-distribution/blob/main/README.md#quick-download)** if you haven't already
51 | 2. **Configure your execution environment** in Labs settings (we recommend "Local Machine")
52 | 3. **Create or open a Fusion project** to start developing with improved performance
53 | 4. **Enjoy faster iteration cycles** with local execution
54 |
55 | ## Troubleshooting
56 |
57 | ### Fusion Debug Info Modal
58 |
59 | For comprehensive debugging and support, Builder Desktop includes a dedicated Fusion Debug Info modal that provides:
60 |
61 | - **Project settings and configuration details**
62 | - **Container logs inspection and download**
63 | - **Direct access to developer tools for the webview**
64 | - **One-click issue reporting with automatic log attachment**
65 |
66 | #### How to Access:
67 |
68 | 1. **Open the command palette** by pressing `Cmd/ctrl + K`
69 | 2. **Type** `fusion: Debug Info` or just `debug info` and select "Fusion: Debug Info" from the dropdown
70 |
71 |
72 |
73 | 3. **The Debug Info modal will open** showing all available debugging tools
74 |
75 |
76 | #### Available Actions in Debug Info Modal:
77 |
78 | - **View Project Settings**: See your current Fusion execution environment and configuration
79 | - **Inspect Logs**: View real-time container logs with counter indicators for repeated messages
80 | - **Download Logs**: Export logs for offline analysis or sharing with support
81 | - **Clear Logs**: Reset the log history for a fresh start
82 | - **Open Dev Tools**: Access browser developer tools for the Fusion webview (useful for debugging frontend issues)
83 | - **Report Issue**: Submit feedback with automatic log attachment for faster support resolution
84 |
85 |
86 |
87 | You can also enable viewing the fusion logs in real time
88 |
89 | 1. Press `cmd/ctrl + k`, then choose `Toggle Developer Options`
90 | 2. Enable `Debug Fusion` to show project startup logs in the interface
91 |
92 |
93 |
94 |
95 |
96 | ### Common Issues and Solutions
97 |
98 | #### Local Machine Issues
99 | - Ensure you have the required development tools (Node.js, Git, etc.) installed
100 | - Check that your project dependencies can be installed locally
101 | - Use the Debug Info modal to view detailed error logs and project configuration
102 |
103 | #### Local Container Issues
104 | - Verify container permissions and access
105 | - Check Docker/Podman installation and configuration
106 | - Review container logs in the Debug Info modal for specific error messages
107 |
108 | #### When to Use Debug Info Modal
109 | - **Project won't start**: Check logs for startup errors and configuration issues
110 | - **Runtime errors**: Monitor real-time logs during development
111 | - **Performance issues**: Download logs for analysis or attach to support tickets
112 | - **Need support**: Use the built-in reporting feature with automatic log attachment
113 |
114 | #### Getting Help
115 | When reporting issues to Builder support:
116 |
117 | 1. Open the Debug Info modal (`Cmd/Ctrl + P` → `fusion: Debug Info`)
118 | 2. Click **"Report Issue"** to open the feedback form
119 | 3. The checkbox to "Include container logs with feedback" will be automatically available
120 | 4. Describe your issue and submit - logs will be securely encrypted and attached
121 | 5. Support staff can decrypt and analyze your logs for faster resolution
122 |
--------------------------------------------------------------------------------