Grouparoo app-example-heroku

An example project for deploying Grouparoo on Heroku.

Goal: To create a scalable and flexible Grouparoo deployment that:

• Has no servers to directly manage
• Can be auto-scaled as needed
• Will be automatically deployed when the code changes
• Is a 12-factor app with all configuration stored in the Environment

How We Got Here

Some of the setup steps have already been done for you to create this app. Here's what we've taken care of:

1. Create a new Grouparoo project. Learn more @ https://www.grouparoo.com/docs/installation.

npm install -g grouparoo
grouparoo init .

2. Install the Grouparoo plugins you want, e.g.: grouparoo install @grouparoo/postgres. Learn more @ https://www.grouparoo.com/docs/installation/plugins

3. Create the Procfile to enable both web and worker dynos. We are running the same code, but using in-line environment varaibles to configure if the instance should boot as a web server or worker.

web:    cd node_modules/@grouparoo/core && WEB_SERVER=true  WORKERS=0  ./bin/start
worker: cd node_modules/@grouparoo/core && WEB_SERVER=false WORKERS=10 ./bin/start

Running this Repo

Assuming you have node.js installed (v12+):

1. git clone https://github.com/grouparoo/app-example-heroku.git
2. cd app-example-heroku
3. npm install
4. cp .env.example .env
5. npm start

Deployment Steps

1. Create a new Heroku app with Heroku Postgres and Heroku Redis.
   • Add the Heroku add-on heroku-postgres via heroku addons:create heroku-postgresql:<PLAN_NAME> or the heroku website. Learn more about the plan options here: https://devcenter.heroku.com/articles/heroku-postgresql. This add-on will set the Environment Variable DATABASE_URL which Grouparoo will automatically use. We recommend at least standard2 for the Postgres Database
   • Add the Heroku add-on heroku-redis via heroku addons:create heroku-redis:<PLAN_NAME> or the heroku website. Learn more about the plan options here: https://devcenter.heroku.com/articles/heroku-redis. This add-on will set the Environment Variable REDIS_URL which Grouparoo will automatically use. We recommend at least premium0 for the Redis Database
2. Configure Heroku to automatically deploy the main branch of your repository on the deploy tab of the Heroku website for your app.
3. Configure the following environment variables:
   • DATABASE_SSL_SELF_SIGNED=true - The lower tier of Heroku databases use self-signed SSL certificates
   • GROUPAROO_LOGS_STDOUT_DISABLE_TIMESTAMP=true- Heroku adds timestamps to all log messages
   • GROUPAROO_LOGS_STDOUT_DISABLE_COLOR=true- Heroku will not render log messages in color

Alternative Deployment Method

Click this button to deploy a copy of this repository!

Notes

• You can scale the number of web and worker processes with the heroku ps command. Depending on your workload, you may need more of one type of process than another.
• Grouparoo will source Heroku's PORT variable automatically to bind to the proper port.
• Heroku uses a Procfile to define the web and worker dynos.
• This repo also powers the Deploy with Heroku button, so there's an app.json file to configure that deployment. You won't need that in your project.

---

Visit https://github.com/grouparoo/app-examples to see other Grouparoo Example Projects.