Server-side application that facilitates peer discovery for collaborative editing sessions in Teletype
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs Extract deployment instructions into their own doc Nov 9, 2017
lib Merge pull request #49 from atom/fail-early-for-missing-oauth-token Apr 20, 2018
migrations Store events when retrieving portals using a malformed ID Nov 10, 2017
script Use throng to run the server in a clustered configuration Sep 21, 2017
test Fail test if middleware permits missing token Apr 20, 2018
.env.example 🎨 Rename env var Nov 22, 2017
.gitignore Tell git to ignore newrelic_agent.log Sep 22, 2017
.travis.yml Configure tests to support interaction with the database Nov 8, 2017
CODE_OF_CONDUCT.md Add Atom's standard CODE_OF_CONDUCT.md Nov 1, 2017
LICENSE.md Add Atom's standard LICENSE.md Nov 1, 2017
Procfile
README.md 📝 You'll want to have a GitHub OAuth app, too Nov 22, 2017
app.json Update app.json Nov 10, 2017
index.js 🎨 Rename variable Nov 22, 2017
newrelic.js 🔥 Sep 25, 2017
package-lock.json
package.json ⬆️ pusher@2.0.1 Jul 24, 2018

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.