Skip to content

Add FAQ about deploy/build requirements #216

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add FAQ about deploy/build requirements #216

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1dfd9ba
Add FAQ about deploy/build requirements
sbleon Mar 10, 2025
826fcc7
Adjust Dockerfile instructions in README
sbleon Jun 9, 2025
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
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,20 @@ Suppose you have an image `app/javascript/images/example.png` that you need to r
1. The image itself can now be referenced by its imported name, e.g. in React, `<img src={Example} />`.
1. The path of the image resolves to `/assets/example-5SRKKTLZ.digested.png`, which is served by the asset pipeline.

### What changes are needed to deploy successfully?

Your build environment needs to have a JS runtime (e.g. [Node](https://nodejs.org/en)) and the `yarn` package manager (v1).

If you're deploying with [Kamal](https://github.com/basecamp/kamal), and you generated a Rails 8 app with the `--js` flag, no changes should be needed. If you added `jsbundling-rails` later, you can add the following to the `build` section of your Dockerfile to install the required packages:
Copy link

Choose a reason for hiding this comment

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

Suggestion:

If you are deploying via the applications Dockerfile, e.g. using Kamal ...

Copy link
Author

Choose a reason for hiding this comment

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

Thanks, Felix. I adjusted the verbiage.


```
# Install things needed to build JS packages (including Node v22)
RUN curl -fsSL https://deb.nodesource.com/setup_22.x -o nodesource_setup.sh && \
bash nodesource_setup.sh
RUN apt-get install -y nodejs
RUN npm install --global yarn
```

## License

JavaScript Bundling for Rails is released under the [MIT License](https://opensource.org/licenses/MIT).