Skip to content

Commit c5cff83

Browse files
committed
adjust documentation
1 parent a59c146 commit c5cff83

File tree

1 file changed

+41
-24
lines changed

1 file changed

+41
-24
lines changed

docs/quickstart.md

Lines changed: 41 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Open your browser and navigate to <http://localhost:2346> to access the web inte
7272

7373
The core `tangram` application provides the shell. All features are added by installing and enabling plugins.
7474

75-
### *Example 1: add system monitoring*
75+
### _Example 1: add system monitoring_
7676

7777
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.
7878

@@ -106,24 +106,40 @@ plugins = ["tangram_system"]
106106

107107
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.
108108

109-
### *Example 2: add live aircraft data*
109+
### _Example 2: add live aircraft data_
110110

111111
To display live flight data, you need the `tangram_jet1090` plugin. This plugin is more advanced, as it requires an external data source.
112112

113113
#### 1. Run the `jet1090` service
114114

115115
The plugin needs a running `jet1090` instance to receive Mode S/ADS-B data. The easiest way to run one is with a container.
116116

117-
```shell
118-
# connects to a public feed.
119-
podman run -d --rm --name jet1090 \
120-
--network=host \
121-
ghcr.io/xoolive/jet1090:latest \
122-
jet1090 --redis-url "redis://127.0.0.1:6379" "ws://feedme.mode-s.org:9876/40128@EHRD"
123-
```
117+
=== "Install pre-built binaries"
118+
119+
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).
120+
121+
Then run it with:
122+
123+
```shell
124+
# connects to a public feed.
125+
jet1090 --redis-url redis://127.0.0.1:6379 ws://feedme.mode-s.org:9876/40128@EHRD
126+
```
127+
128+
=== "Podman/Docker"
129+
130+
```shell
131+
# connects to a public feed.
132+
podman run -d --rm --name jet1090 \
133+
--network=host \
134+
ghcr.io/xoolive/jet1090:latest \
135+
jet1090 --redis-url redis://127.0.0.1:6379 ws://feedme.mode-s.org:9876/40128@EHRD
136+
```
137+
138+
Use your own receiver feed URL if you have one. See [jet1090 documentation](https://mode-s.org/jet1090/sources/)
124139

125140
!!! 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.
127143

128144
#### 2. Install and enable the plugin
129145

@@ -198,23 +214,23 @@ corepack enable pnpm
198214

199215
1. Clone the repository:
200216

201-
```sh
202-
git clone https://github.com/open-aviation/tangram.git
203-
cd tangram
204-
```
217+
```sh
218+
git clone https://github.com/open-aviation/tangram.git
219+
cd tangram
220+
```
205221

206222
2. Build the frontend
207223

208-
```sh
209-
pnpm i
210-
pnpm build
211-
```
224+
```sh
225+
pnpm i
226+
pnpm build
227+
```
212228

213229
3. Install Python dependencies
214230

215-
```sh
216-
uv sync --all-packages --all-groups --all-extras
217-
```
231+
```sh
232+
uv sync --all-packages --all-groups --all-extras
233+
```
218234

219235
This installs the core application and all plugins in editable mode into a virtual environment, along with useful developer utilities.
220236

@@ -239,13 +255,14 @@ To significantly cut down compile times at the cost of much larger binary size,
239255

240256
2. Start the `tangram` server. This runs the FastAPI application, the `channel` service, and all enabled backend plugins.
241257

242-
```sh
243-
uv run tangram serve --config tangram.example.toml
244-
```
258+
```sh
259+
uv run tangram serve --config tangram.example.toml
260+
```
245261

246262
The application will be available at `http://localhost:2346`.
247263

248264
!!! note "Frontend Development"
265+
249266
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.
250267
If you made changes to Rust code, you may need to re-run `uv` with the `--force-reinstall` or `--reinstall-package` flag.
251268

0 commit comments

Comments
 (0)