search

yorkie-team / yorkie-team.github.io

Yorkie Homepage and Documentation
https://yorkie.dev
Apache License 2.0
14 stars 15 forks source link

Add Tutorials for Building Collaborative Applications using JS SDK #91

Open krapie opened 1 year ago

krapie commented 1 year ago

Description:

Add tutorials for building collaborative applications using JS SDK.

Why:

Currently, Yorkie homepage only provides documentation for JS SDK's overall APIs.

It will be better to provide tutorials for building collaborative applications like text editor, whiteboard editor, and other use cases using JS SDK. This will help users to understand how to build collaborative applications using Yorkie.

Kubernetes is a good reference for providing excellent tutorials for various use cases.

Screenshot 2023-07-15 at 6 57 35 PM

Reference: https://kubernetes.io/docs/tutorials/stateless-application/expose-external-ip-address/

hackerwins commented 10 months ago

We have tutorial videos to introduce newcomers to Yorkie and help them understand how to use it. However, these videos are in Korean, which makes it challenging to incorporate them into the homepage.

Here are the tutorial videos:

Yorkie - #0: Getting Started - Watch it here. Yorkie - #1: Creating a Shared Counter - Watch it here. Yorkie - #2: Building a Document Editor - Watch it here.

I'm currently considering how we can integrate these tutorials into our homepage.

krapie commented 10 months ago

If you find this issue interesting, please let me know @banma1234

banma1234 commented 10 months ago

If you find this issue interesting, please let me know @banma1234

videos are greate, but it has limit with with simple javascript example like Shared Counter or Document Editor.

I think we need to focus on framework market such as React or Vue.js.

Maybe we can reuse simple example that already exists like todo-mvc with React and kanban with Vue.js

Both of these examples has moderate level to follow.

Or migrate Document Editor to React project can be an altenative plan. It'll be better plan to new users of yorkie I guess. Because most of the users comes to there mind first is notion-like app when they heard collaborative-app.

banma1234 commented 10 months ago

And also we should write docs in details step by step.

Sepearte them with Getting Started, and create own category to introduce tutorials of create collaborative-app like this.

krapie commented 10 months ago

I think it will be good to add two React.js based tutorials: document editor & whiteboard editor to show well-known usage of collaborative editing.

Seperating tutorials with Getting Started seems like a good idea.