Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update rails reloading instructions in README #1767

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update rails reloading instructions in README #1767

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 5 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,22 +316,15 @@ run Rack::Cascade.new [API, Web]

### Rails

Place API files into `app/api`. Rails expects a subdirectory that matches the name of the Ruby module and a file name that matches the name of the class. In our example, the file name location and directory for `Twitter::API` should be `app/api/twitter/api.rb`.

Modify `application.rb`:

```ruby
config.paths.add File.join('app', 'api'), glob: File.join('**', '*.rb')
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feels like we should leave this for older versions? Maybe just make sections

#### Rails 5.2 or Newer
...

#### Rails 4.0

?

config.autoload_paths += Dir[Rails.root.join('app', 'api', '*')]
```
Place API files into `app/api`. Rails expects a subdirectory that matches the name of the Ruby module and a file name that matches the name of the class. In our example, the file name location and directory for `Twitter::API` should be `app/api/twitter/api.rb`. API changes in development will be picked up automatically.

Modify `config/routes`:

```ruby
mount Twitter::API => '/'
```

See [below](#reloading-api-changes-in-development) for additional code that enables reloading of API changes in development.
For Rails < 5.2, See [below](#reloading-api-changes-in-development) for additional code that enables reloading of API changes in development.

### Modules

Expand Down Expand Up @@ -3412,7 +3405,9 @@ Use [grape-reload](https://github.com/AlexYankee/grape-reload).

### Reloading in Rails Applications

Add API paths to `config/application.rb`.
In Rails >= 5.2, reloading should work without any modification.

For Rails <5.2, add API paths to `config/application.rb`.

```ruby
# Auto-load API and its subdirectories
Expand Down