Skip to content
Server-side application that facilitates peer discovery for collaborative editing sessions in Teletype
Branch: master
Clone or download
Latest commit 5bc511e May 14, 2019

README.md

teletype-server

The server-side application that facilitates peer discovery for collaborative editing sessions in Teletype.

Hacking

Dependencies

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

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 to test pull requests and deploy changes to production.

You can’t perform that action at this time.