Skip to content

Commit 4b2390a

Browse files
authored
Add StateDB to remember users room code (#13)
* Add StateDB to remember users room code * Add images for docs * Add room code instructions to README * Add some more steps to README
1 parent bc3909c commit 4b2390a

File tree

15 files changed

+137
-23
lines changed

15 files changed

+137
-23
lines changed

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,42 @@ To install the extension, execute:
2828
pip install jupyterlab_gather
2929
```
3030

31+
## Setup
32+
33+
1. Go to https://www.100ms.live/ and click `Try for Free` to get started.
34+
35+
![landing page](https://github.com/gjmooney/jupyterlab-gather/blob/add_state_db/docs/images/1_landing.png 'Landing')
36+
37+
2. Login however you like.
38+
39+
![login page](https://github.com/gjmooney/jupyterlab-gather/blob/add_state_db/docs/images/2_login.png 'Login')
40+
41+
3. Select `Video Conferencing`.
42+
43+
![use case page](https://github.com/gjmooney/jupyterlab-gather/blob/add_state_db/docs/images/3_usecase.png 'Use Case')
44+
45+
4. Go to the dashboard.
46+
47+
![role page](https://github.com/gjmooney/jupyterlab-gather/blob/add_state_db/docs/images/4_role.png 'Role')
48+
49+
5. Click on `Join` to see your room details.
50+
51+
![dashboard](https://github.com/gjmooney/jupyterlab-gather/blob/add_state_db/docs/images/5_dashboard.png 'Dashboard')
52+
53+
6. Copy the room code for whichever role you like. This code will be entered on the join form to gain access to the video conference room. Anyone with the code will be able to join the room.
54+
55+
![room code](https://github.com/gjmooney/jupyterlab-gather/blob/add_state_db/docs/images/6_roomcode.png 'Room Code')
56+
57+
7. Start Gather from the JupyterLab start page.
58+
59+
![jupyter](https://github.com/gjmooney/jupyterlab-gather/blob/add_state_db/docs/images/7_jupyter.png 'Jupyter')
60+
61+
8. Enter the room code on the join form and click `Join`.
62+
63+
![gather join](https://github.com/gjmooney/jupyterlab-gather/blob/add_state_db/docs/images/8_gather.png 'Join Room')
64+
65+
9. And that's all! You're all set up!
66+
3167
## Uninstall
3268

3369
To remove the extension, execute:

docs/images/1_landing.png

265 KB
Loading

docs/images/2_login.png

118 KB
Loading

docs/images/3_usecase.png

147 KB
Loading

docs/images/4_role.png

157 KB
Loading

docs/images/5_dashboard.png

165 KB
Loading

docs/images/6_roomcode.png

165 KB
Loading

docs/images/7_jupyter.png

82.7 KB
Loading

docs/images/8_gather.png

50.4 KB
Loading

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@
6565
"@jupyterlab/launcher": "^4.1.5",
6666
"@jupyterlab/services": "^7.0.0",
6767
"@jupyterlab/settingregistry": "^4.0.0",
68+
"@jupyterlab/statedb": "^4.2.1",
6869
"@lumino/signaling": "^2.1.2",
6970
"@lumino/widgets": "^2.3.1",
7071
"@types/react-dom": "^18.2.22",

0 commit comments

Comments
 (0)