Skip to content

Commit

Permalink
Update demo instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
turt2live committed Mar 31, 2023
1 parent ce698cc commit cd3cf50
Showing 1 changed file with 10 additions and 11 deletions.
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,16 @@ To start the demo server: `yarn dev:server`

### Setting up a demo

*Note*: As of writing, there is no server-server API this thing can talk to, unfortunately.

1. `yarn dev:server` to start the server. This will block until killed.
2. In a new terminal window, `yarn dev:client:nobuild`. This will also block until killed.
3. In a third terminal, `yarn dev:client:nobuild`.
4. Grab the auto-assigned user ID from the third terminal and put it on your clipboard.
5. In the second terminal window (first client), type `/createRoom` and press <kbd>Enter</kbd>.
6. You should now have a room that you're chatting in.
7. Type `/invite <the other user ID>` and press <kbd>Enter</kbd>.
8. In the third terminal (second client), follow the instructions to accept the invite.
9. Send whatever text you like in either client and it should be received on the other end.
1. `LM_PORT=3000 LM_SIGNING_KEY_PATH=./p3000.signing.key yarn dev:server` to start the server. This will block until killed.
2. `LM_PORT=3001 LM_SIGNING_KEY_PATH=./p3001.signing.key yarn dev:server` to start the second server in a new terminal window.
3. In a new terminal window, `LM_PORT=3000 yarn dev:client:nobuild`. This will also block until killed.
4. In a fourth terminal window, `LM_PORT=3001 yarn dev:client:nobuild` to start the second client.
5. Grab the auto-assigned user ID from the fourth terminal and put it on your clipboard.
6. In the third terminal window (first client), type `/createRoom` and press <kbd>Enter</kbd>.
7. You should now have a room that you're chatting in.
8. Type `/invite <the other user ID>` and press <kbd>Enter</kbd>.
9. In the fourth terminal (second client), follow the instructions to accept the invite.
10. Send whatever text you like in either client and it should be received on the other end. This will be going over local federation.

Some additional notes:
* The terminal client doesn't support backspace. Just "send" the typo and it'll be fine.
Expand Down

0 comments on commit cd3cf50

Please sign in to comment.