https://github.com/atom/teletype-client

Editor-agnostic library managing client interaction for peer-to-peer collaborative editing in Teletype for Atom
https://github.com/atom/teletype-client

Last synced: 3 months ago
JSON representation

Editor-agnostic library managing client interaction for peer-to-peer collaborative editing in Teletype for Atom

• Host: GitHub
• URL: https://github.com/atom/teletype-client
• Owner: atom
• License: mit
• Archived: true
• Created: 2017-06-05T14:26:28.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-09-28T10:52:02.000Z (about 2 years ago)
• Last Synced: 2024-07-16T01:40:32.037Z (4 months ago)
• Language: JavaScript
• Homepage:
• Size: 988 KB
• Stars: 211
• Watchers: 27
• Forks: 74
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-frontend-graph-library - teletype-client

README

        
##### Atom and all repositories under Atom will be archived on December 15, 2022. Learn more in our [official announcement](https://github.blog/2022-06-08-sunsetting-atom/)

 # teletype-client

The editor-agnostic library managing the interaction with other clients to support peer-to-peer collaborative editing in [Teletype for Atom](https://github.com/atom/teletype).

## Hacking

### Dependencies

To run teletype-client tests locally, you'll first need to have:

- Node 7+

- PostgreSQL 9.x

### Running locally

1. Clone and bootstrap

    ```

    git clone https://github.com/atom/teletype-client.git

    cd teletype-client

    cp .env.example .env

    createdb teletype-server-test

    npm install

    ```

2. Run the tests

    ```

    npm test

    ```

## TODO

* [ ] Document APIs