Heads Up!
This project is a work in progress. We are working on documenting our best practices to help sustainable development for the long term with Ruby on Rails. The Upgrow gem is not yet available and the contents of the guide are still being amended, matured, and reviewed. That being said, feel free to follow the GitHub repo and stay tuned for the latest updates!
Ruby on Rails is the framework of choice for web apps at Shopify. It is an opinionated stack for quick and easy development of apps that need standard persistence with relational databases, an HTTP server, and HTML views.
By design, Rails does not define conventions for structuring business logic and domain-specific code, leaving developers to define their own architecture and best practices for a sustainable codebase.
In fast product development teams, budgets and deadlines interfere with this architectural work, leading to poorly written business logic and complicated code that is very hard to maintain long term. Even when developer teams take the time to think about what a good architecture in Rails look like, this work is likely required to be done all over again when a new Rails app needs to be created.
This project aims to make it easier for both new and existing Rails apps to adopt patterns that are proven to make code more sustainable long term, and codebases easier to maintain and extend. We will recommend a set of abstractions and practices that are simple, yet powerful in organizing code in Rails apps in a way that allows fast-growing apps to remain easy to change.
Visit https://upgrow.shopify.io to learn more about creating a sustainable architecture for your Rails apps.
This project offers a Ruby gem to make it easier for Rails apps to adopt the
sustainable architecture proposed in the Upgrow Guide. To install, add this line
to your application's Gemfile and run bundle install:
gem 'upgrow'For copyright and licensing please refer to LICENSE.txt.