diff --git a/README.md b/README.md index ed00391..3069cd0 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,9 @@ More bi solutions coming soon. ## Production Deployments -TODO +The [production deployments document](docs/PRODUCTION_DEPLOYMENTS.md) explains how to deploy the rails app to Heroku. + +More platforms coming soon. ## Contributing diff --git a/docs/PRODUCTION_DEPLOYMENTS.md b/docs/PRODUCTION_DEPLOYMENTS.md new file mode 100644 index 0000000..2d962b1 --- /dev/null +++ b/docs/PRODUCTION_DEPLOYMENTS.md @@ -0,0 +1,19 @@ +# Production Deployments + +## Heroku + +The project is deployable to Heroku out of the box. + +Fork the repository: +- https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository + +Follow the instructions for deploying to Heroku through the Github integration: +- https://devcenter.heroku.com/articles/github-integration + +Heroku Dashboard offers the option for manual deploys through a user interface: +- https://devcenter.heroku.com/articles/heroku-dashboard + +More information on how to deploy Ruby on Rails apps to Heroku can be found here: +- https://devcenter.heroku.com/articles/getting-started-with-rails7 +- https://devcenter.heroku.com/articles/deploying-rails-applications-with-the-puma-web-server +- https://devcenter.heroku.com/articles/preparing-a-codebase-for-heroku-deployment