Rails modern front-end example using Webpacker 3.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.storybook
app
bin
config
db
lib
log
public
test
tmp
vendor
.babelrc
.editorconfig
.gitignore
.postcssrc.yml
.rubocop.yml
Gemfile
Gemfile.lock
Procfile
README.md
Rakefile
config.ru
package.json
tsconfig.json
tsconfig.test.json
tslint.json
yarn.lock

README.md

Webpacker 3 modern front-end example todo app

Dependency

Features

  • No Sprockets. Using webpacker for overall asset management.
  • Both React client app and normal Rails MVC.
  • Full npm support for sprinkles including import statement.
  • CSRF protection for API call.
  • Add hash suffix to static asset filenames for production(cache-buster).
  • Apply bootstrap CSS both server and client side.
  • TypeScript support for sprinkles and client app.
  • Flux for client architecture using React Redux with static type checking.
  • Using CSS Modules for client compoents styling.
  • Faster UI development using Storybook.
  • Simple API and comprehensive message for assertion by power-assert.
  • Component testing written by TypeScript using mocha and enzyme.
  • Automatic code formatting using pretteir
  • Static code analysis using TSLint
  • Code size analysis using webpack-bundle-analyzer.
  • Using lodash and just actually imported functions are bundled by webpack's tree-shaking.
  • Using Babel to transpile esnext.
  • Hot Module Replacement for development.

Out of the scope

  • Server side rendering
  • Client side routing

How to run

yarn install
bundle install
bin/rails db:setup
bin/rails db:migrate
foreman start

Then open http://localhost:3000/

How to deploy

Run webpacker to build.

RAILS_ENV=production bin/rails webpacker:compile

Then compiled assets will be generated to public/packs/. Copy these files to public directory and run server.

Run client side unit tests

yarn test

Show storybook client UI catalog

yarn storybook

Run client code formatting

yarn prettier

Run client code lint

yarn lint

Bundle size analysis

public/packs/report.html is generated after build finished.