https://github.com/cogru/collaboration-server-protocol

Defines a common protocol for collaboration servers
https://github.com/cogru/collaboration-server-protocol

cogru csp documents

Last synced: 14 days ago
JSON representation

Defines a common protocol for collaboration servers

• Host: GitHub
• URL: https://github.com/cogru/collaboration-server-protocol
• Owner: Cogru
• License: apache-2.0
• Created: 2024-05-18T22:10:15.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-11-04T20:53:58.000Z (2 months ago)
• Last Synced: 2024-11-07T06:19:25.524Z (2 months ago)
• Topics: cogru, csp, documents
• Language: SCSS
• Homepage: https://cogru.github.io/collaboration-server-protocol/
• Size: 3.44 MB
• Stars: 3
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# collaboration-server-protocol

> Defines a common protocol for collaboration servers

[![Build](https://github.com/Cogru/collaboration-server-protocol/actions/workflows/build.yml/badge.svg)](https://github.com/Cogru/collaboration-server-protocol/actions/workflows/build.yml)

`collaboration-server-protocol` (CSP) is the analog to [language-server-protocol][]

(LSP) but for the cross-editor real-time editing.

## 🔧 Development

This section describes how to make the website up and running.

You will need the following tools before setting up the project environment.

- [Node.js][]

- [Hugo][]

- [Go][]

Input these commands to set up the project.

```sh

# Clone this repostiory

$ git clone https://github.com/Cogru/collaboration-server-protocol

# Navigate to the project directory

$ cd collaboration-server-protocol

# Install all dependencies

$ npm install

# Run the web server

$ hugo server

```

Now you can open the browser with the url http://localhost:1313/.

## ⚜ License

Shield: [![CC BY-SA 4.0][cc-by-sa-shield]][cc-by-sa]

This work is licensed under a

[Creative Commons Attribution-ShareAlike 4.0 International License][cc-by-sa].

[![CC BY-SA 4.0][cc-by-sa-image]][cc-by-sa]

[cc-by-sa]: http://creativecommons.org/licenses/by-sa/4.0/

[cc-by-sa-image]: https://licensebuttons.net/l/by-sa/4.0/88x31.png

[cc-by-sa-shield]: https://img.shields.io/badge/License-CC%20BY--SA%204.0-lightgrey.svg

[language-server-protocol]: https://github.com/microsoft/language-server-protocol

[Node.js]: https://nodejs.org/

[Hugo]: https://gohugo.io/

[Go]: https://go.dev/