You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/quickstart.md
+41-24Lines changed: 41 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -72,7 +72,7 @@ Open your browser and navigate to <http://localhost:2346> to access the web inte
72
72
73
73
The core `tangram` application provides the shell. All features are added by installing and enabling plugins.
74
74
75
-
### *Example 1: add system monitoring*
75
+
### _Example 1: add system monitoring_
76
76
77
77
The `tangram_system` plugin adds a widget to the UI that displays server metrics like CPU and memory usage. It is a pure-Python package with no external services.
Stop the running `tangram serve` process (<kbd>Ctrl</kbd> + <kbd>C</kbd>) and start it again. The web interface will now include the system monitoring widget.
108
108
109
-
### *Example 2: add live aircraft data*
109
+
### _Example 2: add live aircraft data_
110
110
111
111
To display live flight data, you need the `tangram_jet1090` plugin. This plugin is more advanced, as it requires an external data source.
112
112
113
113
#### 1. Run the `jet1090` service
114
114
115
115
The plugin needs a running `jet1090` instance to receive Mode S/ADS-B data. The easiest way to run one is with a container.
Follow instructions on the [jet1090 documentation](https://mode-s.org/jet1090/install/#install-prebuilt-binaries) to install `jet1090` on your system (Shell script, Powershell or Homebrew).
Use your own receiver feed URL if you have one. See [jet1090 documentation](https://mode-s.org/jet1090/sources/)
124
139
125
140
!!! tip
126
-
The `jet1090` container is a dependency of the *plugin*, not the `tangram` core. You can run it on any machine as long as it can connect to your Redis instance.
141
+
142
+
The `jet1090` container is a dependency of the _plugin_, not the `tangram` core. You can run it on any machine as long as it can connect to your Redis instance.
This installs the core application and all plugins in editable mode into a virtual environment, along with useful developer utilities.
220
236
@@ -239,13 +255,14 @@ To significantly cut down compile times at the cost of much larger binary size,
239
255
240
256
2. Start the `tangram` server. This runs the FastAPI application, the `channel` service, and all enabled backend plugins.
241
257
242
-
```sh
243
-
uv run tangram serve --config tangram.example.toml
244
-
```
258
+
```sh
259
+
uv run tangram serve --config tangram.example.toml
260
+
```
245
261
246
262
The application will be available at `http://localhost:2346`.
247
263
248
264
!!! note "Frontend Development"
265
+
249
266
Hot Module Replacement (HMR) for frontend plugins is not yet supported. To see changes to frontend components, you must re-run `pnpm build` and restart the `tangram serve` process.
250
267
If you made changes to Rust code, you may need to re-run `uv` with the `--force-reinstall` or `--reinstall-package` flag.
0 commit comments