How to rename a Rails app

Posted March 3, 2022 - tagged ruby-on-rails  ‐  2 min read

Here are the instructions to rename an existing Rails app. Nothing really risky, it should be a set-and-forget thing.

How the Rails your app name was defined

First, the name of your Rails app comes from the "rails new myapp" command. In this example, "myapp" is the name of your Rails app.

  • It creates a folder named "myapp" and put all the default files and directories inside,
  • The main module of the application (under config/application.rb) is named "Myapp" (beware of the first capitalized letter)
  • Some files contains the word "myapp" - like package.json, but I won't list all files here, it depends on what version of Rails and what options you passed to the "rails new" command. Just use the "search and replace" command of your editor.

You will rename occurrences at least 3 times

  • rename the top folder,
  • rename the module under config/application.rb
  • do a find all/replace all for all the remaining occurrences.

Warning, if the original name was too generic, like "rails" or "app", there could be occurrences that do not concern your app's name.

Pay extra attention to the case. Ruby is case-sensitive, so don't go too fast when replacing occurrences.

Conclusion

Renaming a Rails app is not an anxious task. Just take time to change occurrences with care, it will work seamlessly.

And, of course, after that, run your test suite ;)

Build your MVP with Rails

👉 We are 2 Ruby-on-Rails lovers. By building BootrAils, we hope we will help you to launch your Startup idea (really) faster.
Take care ! Health first. 🙏
Shino & David.