Skip to content

Commit

Permalink
Adds "Deploy to Heroku" button (#7)
Browse files Browse the repository at this point in the history
* Create app.json

* Update README.md

* Create Procfile

* Update package.json
  • Loading branch information
MixmasterFresh authored Nov 30, 2020
1 parent bcda0a7 commit edd0123
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 2 deletions.
1 change: 1 addition & 0 deletions Procfile
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
web: node dist/index.js
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[![GPL-3.0 License][license-shield]][license-url] [![Docker Pulls][docker-shield]][docker-url]
[![GPL-3.0 License][license-shield]][license-url] [![Docker Pulls][docker-shield]][docker-url]

<br />
<p align="center">
Expand Down Expand Up @@ -38,6 +38,14 @@

This is the relay server for CrewLink, an Among Us proximity voice chat program. I am currently hosting a server at `ottomated.net:9736`, but if you want a more reliable option I would suggest to deploy this repository yourself.

## Deploy to Heroku

To get up and running quickly, you can deploy to Heroku using the button below

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)

This will deploy an instance of the crewlink-server. You can get the URL of your server by using the app name that you gave when you launched the app on heroku and appending `.herokuapp.com`. You can also find the URL of your server by going to "Settings", scrolling down to "Domains", and removing the `https://` and trailing slash from the url. Using this URL, follow step 4 of the [installation instructions](https://github.com/ottomated/CrewLink-server#manual-installation) to connect your client to your server instance.

## Docker Quickstart

Run the server with [Docker](https://docs.docker.com/get-docker/) by running the following command:
Expand Down
7 changes: 7 additions & 0 deletions app.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"name": "CrewLink Server",
"description": "Voice Relay server for CrewLink",
"repository": "https://github.com/ottomated/CrewLink-server",
"logo": "https://github.com/ottomated/CrewLink-server/raw/master/logo.png",
"keywords": ["node", "among us"]
}
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@
},
"scripts": {
"start": "yarn compile && node dist/index.js",
"compile": "tsc"
"compile": "tsc",
"postinstall": "yarn compile"
},
"devDependencies": {
"@types/express": "^4.17.8",
Expand Down

0 comments on commit edd0123

Please sign in to comment.