@atom/teletype-server
v0.18.2
Published
The server-side application that facilitates peer discovery for collaborative editing sessions in [Teletype](https://github.com/atom/teletype).
Downloads
56
Maintainers
Keywords
Readme
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:
- Node 7+
- PostgreSQL 9.x
- An app on pusher.com
- An OAuth app on github.com
Running locally
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
Copy the
app_id
,key
, andsecret
for your app on pusher.com, and set those values in your.env
fileCopy the client ID and client secret for your OAuth app on github.com, and set those values in your
.env
fileStart the server
./script/server
Run the tests
npm test
Deploying
Atom core team members can use this guide to test pull requests and deploy changes to production.