You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Weave.js is a powerful framework for building end-to-end visual collaborative applications, enabling real-time multi-user interactions on-the-fly. It provides robust synchronization based on Yjs and SyncedStore and provides an extensible API to streamline the development of interactive, collaborative applications.
87
+
Weave.js is a powerful headless framework for building end-to-end collaborative whiteboard applications. Aimed at developers, it provides all the building blocks and plugins to develop visual collaborative canvas, as well as it handles user interactions in real time, so that changes in the visual canvas can be shared among multi users in real time.
88
+
89
+
It provides robust synchronization based on [Yjs][https://yjs.dev/] and [SyncedStore][https://syncedstore.org/docs/] as well as an extensible API to streamline the development of interactive, collaborative applications.
88
90
89
91
<palign="right">(<ahref="#readme-top">back to top</a>)</p>
90
92
91
93
### Built With
92
94
93
-
-[Konva][Konva-url]
94
-
-[Yjs][Yjs-url]
95
-
-[SyncedStore][SyncedStore-url]
95
+
-[Konva][https://konvajs.org/]
96
+
-[Yjs][https://yjs.dev/]
97
+
-[SyncedStore][https://syncedstore.org/docs/]
98
+
99
+
<palign="right">(<ahref="#readme-top">back to top</a>)</p>
<palign="right">(<ahref="#readme-top">back to top</a>)</p>
98
107
99
108
<!-- GETTING STARTED -->
100
109
101
110
## Getting Started
102
111
103
-
TODO
112
+
Follow the [Quickstart documentation][docs-quick-start-url#backend] to create the backend server, which will handle all the real-time synchronization using a Weave.js Store provider, and to startup the backend server running on your local development environment.
113
+
114
+
Follow the [Weave.js documentation][docs-url] for details on setup instructions, usage guidelines, architecture details, and more.
115
+
116
+
<palign="right">(<ahref="#readme-top">back to top</a>)</p>
117
+
118
+
### Prerequisites
119
+
120
+
- macOS, Windows (WSL), or Linux.
121
+
- Node.js 18.18.0 or later.
122
+
- React 18.2.0 or less than 19.x.
104
123
105
124
<palign="right">(<ahref="#readme-top">back to top</a>)</p>
106
125
107
126
<!-- ROADMAP -->
108
127
109
128
## Roadmap
110
129
111
-
TODO
130
+
Check out [Weave.js roadmap][docs-roadmap-url] for details on planned work and the features that will come next.
112
131
113
132
<palign="right">(<ahref="#readme-top">back to top</a>)</p>
114
133
115
134
<!-- CONTRIBUTING -->
116
135
117
136
## Contributing
118
137
119
-
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
120
-
121
-
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
122
-
Don't forget to give the project a star! Thanks again!
123
-
124
-
1. Fork the Project
125
-
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
126
-
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
127
-
4. Push to the Branch (`git push origin feature/AmazingFeature`)
128
-
5. Open a Pull Request
138
+
Contributions are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines on how to contribute to this project.
129
139
130
140
<palign="right">(<ahref="#readme-top">back to top</a>)</p>
0 commit comments