{"id":15151527,"url":"https://github.com/identitysquare/rails-boilerplate","last_synced_at":"2025-09-29T20:31:26.670Z","repository":{"id":53287703,"uuid":"255653667","full_name":"IdentitySquare/rails-boilerplate","owner":"IdentitySquare","description":"🛤🚂 Rails 6 opinionated starter template with a lot of setup done for you to get started quickly.","archived":true,"fork":false,"pushed_at":"2021-04-19T20:42:50.000Z","size":936,"stargazers_count":6,"open_issues_count":6,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-12-06T22:44:45.728Z","etag":null,"topics":["boilerplate","rails","rails6","starter"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/IdentitySquare.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-04-14T15:51:34.000Z","updated_at":"2023-01-28T09:23:01.000Z","dependencies_parsed_at":"2022-08-28T17:02:48.794Z","dependency_job_id":null,"html_url":"https://github.com/IdentitySquare/rails-boilerplate","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IdentitySquare%2Frails-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IdentitySquare%2Frails-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IdentitySquare%2Frails-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IdentitySquare%2Frails-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/IdentitySquare","download_url":"https://codeload.github.com/IdentitySquare/rails-boilerplate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234659895,"owners_count":18867636,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["boilerplate","rails","rails6","starter"],"created_at":"2024-09-26T15:04:06.286Z","updated_at":"2025-09-29T20:31:26.307Z","avatar_url":"https://github.com/IdentitySquare.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Rails Boilerplate\n\nA standard set of gems, libraries and configurations we use for our new projects.\n\n## What is included?\n\n*Backend:*\n* PostgreSQL\n* Devise\n* Omniauth\n  * Connect with Google\n  * Connect with Facebook\n* Kaminari\n* Pundit\n* Active Admin\n  * activeadmin_addons\n* Active Storage\n* Sidekiq\n* Redis\n* Friendly IDs\n* raygun4ruby\n* sitemap_generator\n* strong_migrations\n* paper_trail\n* strong_password\n* acts_as_paranoid\n* pretender\n* valid_email2\n\n*Frontend*:\n* HAML\n* Webpacker\n* SASS\n* Simple Forms\n* High Voltage\n* kaminari\n* bootstrap4-kaminari-views\n* meta-tags\n\n*Development tools:*\n* Better Errors\n* Awesome print\n* Hirb\n* Bullet\n* Peek\n* Guard live reloads\n* Annotate\n* Letter opener\n\n*Models:*\n* User\n* AdminUser (for internal admin)\n\n*Testing:*\n\n* RSPEC\n* Shoulda matchers\n* Factory bot\n* Faker\n* Capybara\n\n\n# Getting started\n\n## 1. Rename Database name\nGo to `config/database.yml` to change your database names and authentication methods.\n\n```\n rails db:setup\n```\n\n\n## 2. Setting your secret keys\n\nOpens the encrypted file in an editor. We use atom.\n\n```\n  EDITOR=\"atom --wait\" rails credentials:edit\n```\n\n##### Changing the `master.key`\n1. Delete the `master.key` and the encrypted file `config/credentials.yml.enc`.\n2. Run the above commands to edit the encrypted files. Which will generate a new `master.key`.\n3. Copy and paste the values from `config/credentials.template.yml` to the encrypted file.\n\n\n\n## 3. Deploying to Heroku:\n\n1. Create a Heroku App\n2. Create a `RAILS_MASTER_KEY` ENV variable. Rails will detect it and use it as your master key, e.g. in Heroku: `heroku config:set RAILS_MASTER_KEY=\u003cyour-master-key-here\u003e` OR set ENV variable in the Heroku UI.\n3. Deploy your code\n4. Add Heroku Postgres addon.\n5. Once deploy has completed, run `rails db:migrate` on Heroku. `heroku run rails db:migrate -a \u003cyour-heroku-app-name\u003e`.\n6. Setup required dynos.\n7. Worker setup for Sidekiq\n8. Provision Redis for Sidekiq\n9. Restart all dynos\n\n## 4. Outbound Emails in production\n\nOn Heroku use Mailgun or setup the following ENV variables:\n\n```ruby\n  ENV['SMTP_USERNAME']\n  ENV['SMTP_PASSWORD']\n  ENV['SMTP_ADDRESS']\n  ENV['MAILGUN_SMTP_PORT']\n```\n\n## 5. Omniauth with Google \u0026 Facebook\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fidentitysquare%2Frails-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fidentitysquare%2Frails-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fidentitysquare%2Frails-boilerplate/lists"}