kjirou / minimum_javascript_on_rails

A Rails application that is set a minimal Node.js-based JavaScript build environment without webpacker

minimum_javascript_on_rails

• README (English)
• README (日本語)

💁‍♀️ What application is this?

This is a sample of a Ruby on Rails application that is set a minimal Node.js-based JavaScript build environment without webpacker.

If your Rails application meets some of the following conditions, using this repository configuration may be more maintainable.

• Does not contain much JavaScript code.
• sprockets-rails is enough for the style-sheet build environment.
• Does not install unused npm packages.
• Manages npm packages as individually as possible so that the required packages can be updated immediately.
• Developers want to learn more basic JavaScript knowledge than webpacker.

🔧 Installation

Softwares that needs to be locally installed

• Ruby == 2.6
• Node.js == 10

Install this sample application

git clone [e-mail]:kjirou/minimum_javascript_on_rails.git
bin/setup

🐱 Functions added to the client side

• npm run build
  • This command is for a stand-alone build. Mainly we use it for production release.
• npm run watch
  • If the npm run watch is running with the rails server, JavaScript source changes are applied when you reload the browser.
• npm run clean
  • Clean up files generated from npm run build or npm run watch.

⚙️ Customize settings

Run unit tests with Jest on Node.js

• See this pull-request.

Change the Babel to the TypeScript

• See this pull-request.

Create a client side development environment

• (Write later?)

Build CSS with Node.js

• (Write later?)

Use Stimulus

• (Write later?)

Prevent the "Please execute npm run build command before operating the Rails." error

• See this pull-request.

Reduce the file size of the built JavaScript

• I'm sorry, I don't know well.
• You should probably search for "webpack chunk" first.