Skip to content

Commit 0ed5304

Browse files
authored
Merge pull request #244 from crabnebula-dev/CrabNejonas-patch-2
Update and rename ARCHITECTURE.md to DEVELOPING.md
2 parents 0c5807a + 1c4a541 commit 0ed5304

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

ARCHITECTURE.md renamed to DEVELOPING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
1+
# Developing
2+
3+
There are a couple components to devtools that you should know about:
4+
- `crates/devtools-core` The core instrumentation library that will cappture and process `tracing` data from your app.
5+
- `crates/devtools` The user-facing Tauri plugin that hooks `devtools-core` into a Tauri app.
6+
- `crates/devtools-v1` The Tauri plugin for legacy Tauri v1.x versions
7+
- `crates/wire` The protobuf files that define the message protocol between the instrumentation and GUI.
8+
- `clients/web` The user-facing web GUI that is hosted at `devtools.crabnebula.dev`
9+
10+
## Developing locally
11+
12+
By default the instrumentation has strict CORS checks enabled to ensure only the legitimate frontend hosted at `devtools.crabnebula.dev` can access the data, as this would also block the frontend running locally in development mode (`localhost` doesn't match `devtools.crabnebula.dev`) these checks can be disabled by setting the environment variable `__DEVTOOLS_LOCAL_DEVELOPMENT=true`. If you run the examples contained within this repo through `cargo` or the Tauri CLI nothing needs to be done, that environment variable is set automatically.
13+
114
# Architecture
215

316
The core observation behind DevTools is that Tauri apps are *interactive* and *long-running* processes,

0 commit comments

Comments
 (0)