Feature: Simplify local development and update docs #1
Conversation
|
@hpx7 Not sure if you've seen this yet, and no rush. Review when you're ready 🙂 |
|
|
||
| ```sh | ||
| mkcert -install | ||
| mkcert localhost | ||
| ``` | ||
|
|
||
| Install dependencies: | ||
| Make sure to add `*.pem` to your `.gitignore` file to avoid committing the certificate files. |
There was a problem hiding this comment.
is this needed? *.pem is already in the gitignore for this repo
There was a problem hiding this comment.
oh i see you're suggesting installing the local-coordinator into your hathora project
|
|
||
| Start the coordinator process: | ||
| - Install with `npm i https://github.com/hathora/local-coordinator.git` |
There was a problem hiding this comment.
what's the advantage of doing this vs just running npm start in this repo?
i guess you get to avoid having to clone this repo?
what about suggesting that people globally install this package? but not sure how they would install the cert files to it
There was a problem hiding this comment.
Thanks for the input!
The main advantage is installing all project dependencies where they are used, and from the user's perspective, keeping the cert files needed for hathora's local-coordinator in the same project as the other backend code, and game frontend code.
The cert files are the main problem when using a global install, although I guess we could add a CLI option to specify where to find the cert files (or use process.cwd()) to solve that.
Would it be possible to improve the main hathora project to better support a local-coordinator?
Otherwise, feel free to leave this if this is not a priority at the moment!
There was a problem hiding this comment.
i don't think you would normally have cert files in your hathora project.
what's the main pain point you currently have with the local-coordinator with hathora?
There was a problem hiding this comment.
The main pain point is having two separate directories - one for the game and another for local-coordinator
However, there are many ways to automate this.
I'm open to close this and focus on more important improvements.
local-coordinatorto be executed as a npm binary, unlockingnpx local-coordinatorafter installinglocal-coordinatorin your Hathora project.ts-nodeto latest minor to allow full Node ESM loading support.Perhaps the main Hathora docs should be improved further too.