Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Tutorials for Building Collaborative Applications using JS SDK #91

Open
krapie opened this issue Jul 15, 2023 · 5 comments
Open

Add Tutorials for Building Collaborative Applications using JS SDK #91

krapie opened this issue Jul 15, 2023 · 5 comments
Labels
documentation 📔 Improvements or additions to documentation good first issue 🐤 Good for newcomers

Comments

@krapie
Copy link
Member

krapie commented Jul 15, 2023

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/

@krapie krapie changed the title Add Tutorials for building Collaborative Applications using JS SDK Add Tutorials for Building Collaborative Applications using JS SDK Jul 15, 2023
@hackerwins hackerwins added documentation 📔 Improvements or additions to documentation good first issue 🐤 Good for newcomers labels Oct 26, 2023
@hackerwins
Copy link
Member

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
Copy link
Member Author

krapie commented Nov 9, 2023

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

@banma1234
Copy link
Contributor

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
Copy link
Contributor

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
Copy link
Member Author

krapie commented Nov 11, 2023

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📔 Improvements or additions to documentation good first issue 🐤 Good for newcomers
Projects
Status: Backlog
Development

No branches or pull requests

3 participants