-
-
Notifications
You must be signed in to change notification settings - Fork 95
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(overmind-devtools): start architecture draft
- Loading branch information
1 parent
d44e987
commit 914b243
Showing
3 changed files
with
574 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,21 @@ | ||
# overmind-devtools | ||
### Introduction | ||
|
||
To be filled | ||
There are three packages related to `overmind-devtools` experience: | ||
* [overmind-devtools-client](../overmind-devtools-client/) - "core" package that provides UI ("web client") | ||
* [overmind-devtools](../overmind-devtools/README.md) - standalone, electron application | ||
* [overmind-devtools-vscode](../overmind-devtools-vscode/) - VSCode extension | ||
|
||
`overmind-devtools-client` is a core application that can be hosted by available "hosts": `overmind-devtools` and `overmind-devtools-vscode`. | ||
|
||
![overmind-devtools-packages](./docs/assets/overmind-devtools-packages.png) | ||
|
||
This means that this package (a reminder: we're now in `overmind-devtools-client` package of the monorepo) is **crucial** for the other two. | ||
|
||
In case you want to improve devtools experience (UI, UX, etc.), focus on this package specifically. | ||
|
||
### Local development | ||
This package bundle (`bundle.js`) is further used by the companion "host" packages (mentioned before). | ||
|
||
Hence, make sure you've build this package before development. | ||
|
||
**HINT**: the easiest way to start local development is to run [overmind-devtools](../overmind-devtools/README.md) electron app. |
Binary file added
BIN
+89.1 KB
packages/overmind-devtools-client/docs/assets/overmind-devtools-packages.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.