Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/atom/teletype
Share your workspace with team members and collaborate on code in real time in Atom
https://github.com/atom/teletype
atom collaborative-editing package realtime-collaboration
Last synced: about 2 months ago
JSON representation
Share your workspace with team members and collaborate on code in real time in Atom
- Host: GitHub
- URL: https://github.com/atom/teletype
- Owner: atom
- License: mit
- Archived: true
- Created: 2017-06-06T09:22:09.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-13T04:40:31.000Z (over 1 year ago)
- Last Synced: 2024-07-19T13:46:22.501Z (about 2 months ago)
- Topics: atom, collaborative-editing, package, realtime-collaboration
- Language: JavaScript
- Homepage: https://teletype.atom.io
- Size: 1.59 MB
- Stars: 2,409
- Watchers: 81
- Forks: 321
- Open Issues: 183
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-robotic-tooling - Teletype - Share your workspace with team members and collaborate on code in real time in Atom. (Development Environment / Code and Run)
- awesome-robotic-tooling - Teletype - Share your workspace with team members and collaborate on code in real time in Atom (Development Environment / Code and Run)
- awesome-frontend-graph-library - Teletype
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 for Atom
An Atom package that lets developers share their workspace with team members and collaborate on code in real time.
Learn more at [teletype.atom.io](https://teletype.atom.io).
## Installation
### Command Line
1. Install [Atom 1.22](https://atom.io) or newer
2. In the terminal, install the package via apm:
```sh
apm install teletype
```
### GUI
1. Install [Atom 1.22](https://atom.io) or newer
1. Launch Atom
1. Open Settings View using Cmd+, on macOS or Ctrl+, on other platforms
1. Click the Install tab on the left side
1. Enter `teletype` in the search box and press Enter
1. Click the "Install" button that appears
## Hacking
This package is powered by three main components:
- [teletype-crdt](https://github.com/atom/teletype-crdt): The string-wise sequence CRDT that enables peer-to-peer collaborative editing.
- [teletype-server](https://github.com/atom/teletype-server): The server-side application that facilitates peer discovery.
- [teletype-client](https://github.com/atom/teletype-client): The editor-agnostic library that manages the interaction with other clients.
### Dependencies
To run teletype tests locally, you'll first need to have:
- Atom 1.22 or later
- Node 7+
- PostgreSQL 9.x
### Running locally
1. Clone and bootstrap
```
git clone https://github.com/atom/teletype.git
cd teletype
createdb teletype-test
apm install
```
2. Run the tests
```
atom --test test
```