https://github.com/maximilianheidenreich/syncboard
A synchonized peer to peer board with checkable items.
https://github.com/maximilianheidenreich/syncboard
svelte utilities webapp webrtc
Last synced: 2 months ago
JSON representation
A synchonized peer to peer board with checkable items.
- Host: GitHub
- URL: https://github.com/maximilianheidenreich/syncboard
- Owner: MaximilianHeidenreich
- Created: 2021-04-14T15:42:16.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-04-14T19:07:25.000Z (about 5 years ago)
- Last Synced: 2025-05-30T23:25:05.123Z (about 1 year ago)
- Topics: svelte, utilities, webapp, webrtc
- Language: Svelte
- Homepage: https://syncboard.maximilian-heidenreich.de
- Size: 1.15 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![GPLv3 License][license-shield]][license-url]
[contributors-shield]: https://img.shields.io/github/contributors/MaximilianHeidenreich/SyncBoard.svg?style=flat-square
[contributors-url]: https://github.com/MaximilianHeidenreich/SyncBoard/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/MaximilianHeidenreich/SyncBoard?style=flat-square
[forks-url]: https://github.com/MaximilianHeidenreich/SyncBoard/network
[stars-shield]: https://img.shields.io/github/stars/MaximilianHeidenreich/SyncBoard?style=flat-square
[stars-url]: https://github.com/MaximilianHeidenreich/SyncBoard/stargazers
[issues-shield]: https://img.shields.io/github/issues/MaximilianHeidenreich/SyncBoard?style=flat-square
[issues-url]: https://github.com/MaximilianHeidenreich/SyncBoard/issues
[license-shield]: https://img.shields.io/github/license/MaximilianHeidenreich/SyncBoard?style=flat-square
[license-url]: https://github.com/MaximilianHeidenreich/SyncBoard/blob/master/LICENSE
SyncBoard
A synchonized peer to peer board with checkable items.
Explore the docs »
Report Bug
·
Request Feature
·
Live Demo
## Table of Contents
- [Table of Contents](#table-of-contents)
- [About The Project](#about-the-project)
- [Usage](#usage)
- [Create a new board](#create-a-new-board)
- [Join a board](#join-a-board)
- [Contributing](#contributing)
- [Contact](#contact)
## About The Project
I created this project because I needed something to test WebRTC and Svelt on. This project was inspired by the board I noticed in [this video](https://www.youtube.com/watch?v=58AmCK-EZ50&t=325s).
Basically, its just a collection of big checkbox buttons which is shared between two peers.
If one peer checks a button, it won't be clickably by anyone else and it is possible to distinguish buttons that you and others have clicked.
## Usage
#### Create a new board
> Just click the *'Start a new board'* button, add your tasks and share the url with someone else
>
> Click on a task to mark it as completed.
#### Join a board
> Either open the url someone shared with you or enter the alpha-numerical id into the *'Board ID'* field and press the *'Join existing room'* button.
## Contributing
Feel free to contribute to this project if you find something that is missing or can be optimized.
If you do so, please follow these steps:
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## Contact
Maximilian Heidenreich - github@maximilian-heidenreich.de
Project Link: [https://github.com/MaximilianHeidenreich/SyncBoard](https://github.com/MaximilianHeidenreich/SyncBoard)
Project Icon: [https://github.com/MaximilianHeidenreich/SyncBoard/blob/master/static/Icon-1024.png](https://github.com/MaximilianHeidenreich/SyncBoard/blob/master/static/Icon-1024.png)
