search

y-crdt / ydotnet

.NET bindings for yrs.
MIT License
29 stars 9 forks source link

Add readme with steps how to launch demo #98

Closed andreyleskov closed 2 weeks ago

andreyleskov commented 2 months ago

I tried to launch demo on local machine and stumbled upon many issues. As a person with backend C# background it took me three hours to launch the demo and see how yrdt persist documents in mongo. This is a great project and it deserves a better onboarding and demo launch experience. Please find the updated README.md with steps it took me to have demo up and running plus minor code changes.

SebastianStehle commented 2 months ago

Sorry. I have forgotten to review your PR. I have only focused on the readme, because the other files also contain some test code. This needs to be cleaned up before something can be merged.

By default it should be possible to run the demo without MongoDB.

andreyleskov commented 1 month ago

@SebastianStehle done, please review. Only left ReadMe, for launching with in-memory persistence locally with dependencies install.

This project is C# and I can imagine backend-heavy folks like me can be attracted for realtime collaboration feature, but struggle to launch it due to lack of knowledge with frontend part. A good option in my opinion is to include a compose file and dockerfile with all the build and setup steps, to launch in one command.

SebastianStehle commented 2 weeks ago

Closing because of inactivity