Skip to content

Commit 82090fb

Browse files
dpraimeyuuhenri-hulski
authored andcommitted
docs(overmind-devtools): document local setup
1 parent f39bb61 commit 82090fb

File tree

2 files changed

+21
-2
lines changed

2 files changed

+21
-2
lines changed
Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,22 @@
1-
# overmind-devtools
1+
### Introduction
22

3-
To be filled
3+
This package is one of three packages related to `overmind-devtools`.
4+
5+
If you're looking for a little deeper insight about these, please check [overmind-devtools-client](../overmind-devtools-client/README.md).
6+
7+
### Local development
8+
9+
**PREREQUISITE**: make sure you firstly [built](../overmind-devtools-client/README.md) devtools UI core so that it can be hosted by this package (electron application).
10+
11+
Considering the above prerequisite is satisfied, run the following steps:
12+
1. Build the host:
13+
```sh
14+
npm run build
15+
```
16+
2. Run the application:
17+
```sh
18+
npm run prod
19+
```
20+
3. Use `Application` tab and then clicking on `Open Chrome DevTools`:
21+
22+
![overmind-devtools-debugging](./docs/assets/overmind-devtools-debugging.png)
72.8 KB
Loading

0 commit comments

Comments
 (0)