Skip to main content

Official docs for Shakapacker

Keep Rails conventions while using modern JS and CSS bundling.

Start from the recommended install flow, then branch into migration, Rspack, TypeScript, and deployment guidance as needed.

Start with docsBrowse resourcesGet support

Recommended first run

  1. bundle add shakapacker
  2. bin/rails shakapacker:install
  3. bin/rails assets:precompile

Follow with configuration and deployment docs to align your local setup with production.

Choose your path

Start where your Rails app is today.

Installing into an existing Rails app

Follow the canonical install path and keep your current Rails structure while adding modern bundling.

Install Shakapacker

Upgrading from an older release

Use upgrade checklists and release notes to move between major versions without guessing.

Review upgrade guidance

Migrating from Webpack to Rspack

Use the migration guide to adopt Rspack while preserving existing Rails integration patterns.

Open the Rspack guide

Troubleshooting build and deploy issues

Diagnose common compile and runtime failures with practical fixes for Rails production workflows.

Use troubleshooting docs

Recommended flow

Keep setup deterministic before expanding into advanced bundling choices.

Recommended first step

Start from the install baseline before tuning advanced options or loader stacks.

bundle add shakapackerStart with configuration

Initialize app files

Generate config and binstubs in one step so your app has the expected Shakapacker structure.

bin/rails shakapacker:installRun installer steps

Validate deployment path

Precompile with the same task your deployment pipeline runs so failures show up early.

bin/rails assets:precompileRead deployment docs

Key references

Use focused docs for API details, upgrades, and loader migrations.

API Reference

View helper and configuration APIs used by production Rails apps.

Open guide

TypeScript and Loader Setup

Enable TypeScript and choose loader strategies for JavaScript and CSS pipelines.

Open guide

Version Upgrade Guides

Follow major-version upgrade notes for v6 through v9 and common migration pitfalls.

Open guide

Production notes

Shakapacker docs stay focused on operationally useful guidance.

Shakapacker keeps bundling inside Rails conventions so teams can preserve one deploy pipeline and one operational model.

Deployment modelSingle release workflow

The docs are synced from the upstream repository, so guidance and code evolve together instead of drifting.

Documentation sourceVersion-aligned guidance

Expert help

Get free advice from the team behind Shakapacker

ShakaCode maintains Shakapacker and supports teams with setup audits, migration plans, and production debugging. Book a complimentary 30-minute assessment for direct implementation guidance.

Book a complimentary assessmentLearn about ShakaCode