docs: add root README and document backend WebSocket API#26
docs: add root README and document backend WebSocket API#26ShashwatAgrawal20 wants to merge 3 commits into
Conversation
Signed-off-by: Shashwat Agrawal <shashwatagrawal473@gmail.com>
ShashwatAgrawal20
requested review from
Shobhit-Nagpal and
kayareyouokay
as code owners
|
you should add a source to some blog for understanding "exchange" too ig? |
|
|
||
| This starts a local server. Open the URL shown in your terminal (usually http://localhost:5173). | ||
|
|
||
| ### Step 4: Start the Simulator |
There was a problem hiding this comment.
nit: we can remove this part. there's not going to be a simulator from what i am aware of
There was a problem hiding this comment.
Yeah, makes sense. I'm not entirely sure if we'll have a simulator part or not, but irrc we might still need it for testing purposes.
|
|
||
| ## API | ||
|
|
||
| The server uses **WebSocket over TLS** (`wss://`) on port `7000`. Connect to `wss://localhost:7000`. |
There was a problem hiding this comment.
question: any specific reason for 7000 port? is it convention or just for the love of the game?
There was a problem hiding this comment.
Now that you mention it, I'm not entirely sure where 7000 came from either, probably copied it up from some repos I was referring to. If it was truly for the love of the game, I would've gone with 6969 😜
Replace the draft overview with accurate setup, component roles, and workflow notes. Demo users match backend AuthManager (shashwat, nero) instead of the non-existent test/test account. Closes builder-inc#24.
|
Pushed a polish pass on this branch:
Still closes #24. |
3 participants
closes #24
The API examples within backend/ uses
test/testas a demo user.Support for this user is added in #25