diff --git a/examples/simultaneous-cursors/README.md b/examples/simultaneous-cursors/README.md new file mode 100644 index 000000000..c07d50a5a --- /dev/null +++ b/examples/simultaneous-cursors/README.md @@ -0,0 +1,61 @@ +# Yorkie Simultaneous-Cursors Example + +
+ + + +
+ + + +## How to run demo + +### With Yorkie Dashboard + +Install dependencies + +```bash +$ npm install +``` + +Create an account on [Yorkie Dashboard](https://yorkie.dev/dashboard) +Create a new project and copy your public key from the dashboard +Update the `.env` file like so: + +``` +VITE_YORKIE_API_ADDR='https://api.yorkie.dev' +VITE_YORKIE_API_KEY='your_key_xxxx' +``` + +Start demo project + +```bash +$ npm run dev +``` + +### With local Yorkie server + +Install dependencies + +```bash +$ npm install +``` + +At project root, run below command to start Yorkie and Envoy proxy. + +```bash +$ docker-compose -f docker/docker-compose.yml up --build -d +``` + +Update the `.env` file like so: + +``` +VITE_YORKIE_API_ADDR='http://localhost:8080' +VITE_YORKIE_API_KEY='' +``` + +Start demo project + +```bash +$ npm run dev +``` diff --git a/examples/simultaneous-cursors/thumbnail.jpg b/examples/simultaneous-cursors/thumbnail.jpg new file mode 100644 index 000000000..f8dafd17d Binary files /dev/null and b/examples/simultaneous-cursors/thumbnail.jpg differ