@atom/teletype-server

Dependencies

• Node 7+
• PostgreSQL 9.x

Running locally

1. Clone and bootstrap

   git clone https://github.com/atom/teletype-server.git ~/github/teletype-server
   cd ~/github/teletype-server
   cp .env.example .env
   createdb teletype-server-dev
   npm install
   npm run migrate up
   

2. Setup Pusher

3. Ask @as-cii, @nathansobo, or @jasonrudolph to add you as a collaborator on the teletype-development app.

4. Copy the key and secret from Pusher, and set those values in your .env file.

5. Start the server

   ./script/server
   

Testing pull requests

Visit the atom-tachyon pipeline dashboard on Heroku.

In the left-hand column, you'll see a review application for each open pull request on this repository.

Alternatively, you can also wait for a deployment notification to be displayed directly on the pull-request.

The teletype package can be instructed to use one of these servers by opening the package's settings page and assigning the base URL.

You'll need to reload the window for the change to take effect. You should not normally need to touch the Pusher key as we use the same Pusher account on both staging and production.

Deploying

1. Ask @as-cii, @nathansobo, @jasonrudolph, or @iolsen to grant you deploy access on https://dashboard.heroku.com/apps/atom-tachyon.

2. Visit the atom-tachyon pipeline dashboard on Heroku.

3. Whenever someone pushes to master, its contents are automatically deployed to staging. Use the instructions from the testing section above with the base URL of https://atom-tachyon-staging.herokuapp.com/ if you'd like to test the Atom package against staging before deploying.

4. Once you're satisfied with your testing, click Promote to production... on the staging app to move the staging slug to the production app.

Chat-ops

You can also interact with our Heroku pipeline on Slack via ChatOps. Check out this page for more information.