Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/atom/teletype-server
Server-side application that facilitates peer discovery for collaborative editing sessions in Teletype
https://github.com/atom/teletype-server
Last synced: 13 days ago
JSON representation
Server-side application that facilitates peer discovery for collaborative editing sessions in Teletype
- Host: GitHub
- URL: https://github.com/atom/teletype-server
- Owner: atom
- License: mit
- Archived: true
- Created: 2017-05-19T15:11:06.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-07T23:20:30.000Z (almost 2 years ago)
- Last Synced: 2024-08-02T11:23:54.819Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 409 KB
- Stars: 118
- Watchers: 27
- Forks: 53
- Open Issues: 12
-
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-server
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-server
The server-side application that facilitates peer discovery for collaborative editing sessions in [Teletype](https://github.com/atom/teletype).
## Hacking
### Dependencies
To run teletype-server locally, you'll first need to have:
- Node 7+
- PostgreSQL 9.x
- An app on [pusher.com](https://pusher.com/docs/javascript_quick_start#get-your-free-API-keys)
- An [OAuth app on github.com](https://developer.github.com/apps/building-integrations/setting-up-and-registering-oauth-apps/registering-oauth-apps/)
### Running locally
1. Clone and bootstrap
```
git clone https://github.com/atom/teletype-server.git
cd teletype-server
cp .env.example .env
createdb teletype-server-dev
createdb teletype-server-test
npm install
npm run migrate up
```
2. Copy the `app_id`, `key`, and `secret` for your app on pusher.com, and set those values in your `.env` file
3. Copy the client ID and client secret for your OAuth app on github.com, and set those values in your `.env` file
4. Start the server
```
./script/server
```
5. Run the tests
```
npm test
```
## Deploying
Atom core team members can use [this guide](./docs/deployment.md) to test pull requests and deploy changes to production.