Bullet Trainとは
Bullet TrainとはRailsをベースにして、多くのサービスに普段ついているユーザー登録・認証やAPI関係の機能など、ビューのテンプレートなどを、新しいアプリを作った時点で全部提供してくれる、ウェブサイトを作るためのSaaSフレームワークです。
開発自体がRailsとほとんど変わりません。普通の線路(Rails)より新幹線(Bullet Train)のごとく、サイトの開発をとても速くしてくれるフレームワークですので、皆さんにぜひ一度でも使ってみていただきたいと思います。
「メニューはお任せ」
Railsを普段やっている人であれば「メニューはお任せ」という概要について聞いたことがあるでしょう。
How do you know what to order in a restaurant when you don’t know what’s good? Well, if you let the chef choose, you can probably assume a good meal, even before you know what “good” is. That is omakase.
レストランに食べに行く時、メニューで何が美味しいか分からなければ何を頼んだらいいか迷いますよね。ただし、もしシェフに任せてオススメのメニューを注文したら、何が美味しいか分からなくても、シェフがオススメするものは美味しいだろうと予想がつくと思います。それは「お任せ」です。
要するに、Railsの「設定より規約」よりもうちょっと具体的で、フレームワークを提供している人にどのツールやライブラリーなどを使うか任せるイメージです。
そして、Bullet Trainを作ったAndrew Culverは曰く、もしRailsは「メニューはお任せ」なのであれば、Bullet Trainは食事だけでなく、どのホテルに泊まるかとか、観光は何を見に行くかとかまで、一番オススメの旅行のスケジュールを組み立ててくれるフレームワークです。
試しに新しいアプリを作りましょう
ザッとどんな感じなのか見ていきたいと思います。
事前準備
始まる前に下記のものはインストールしていることを確認してください。
(3月29日現在からはバージョンが変わる可能性あり)
- Ruby 3.1.1
- Node v16.14.0
- PostgreSQL
- Redis
- Sidekiq
ローカルの環境が整ったら次のコマンドで新規のBullet Trainのアプリを作りましょう:
$ git clone git@github.com:bullet-train-co/bullet_train.git your_new_project_name
your_new_project_name
の代わりに好きな名前を書いてください。
次はディレクトリーに入りましょう:
$ cd your_new_project_name
本来は次にbin/configure
を実行してGitHubで新しいレポジトリーを作くるべきなのですが、軽く紹介する目的で本記事を書いていますので、まずローカルで立ち上げてみたいなので次のコマンドを実行してください:
$ bin/setup
bin/setup
の手順に従った後、サーバーを立ち上げましょう。
もし下のコマンドでエラーが出てプロセスが終了したら、別のタブで$ redis-server
を打ってからやり直してみてください:
$ bin/dev
以上。
ユーザー登録やログイン
https://localhost:3000
にアクセスすると下の画面が出てきます:
見ての通りdeviseはもうすでに実装されてあり、Tailwindを使ってのビューも準備万全。
では、次に「Don't have an account?」を押してアカウントを作りましょう:
この時点でメールは自動的に送られて新しいタブで出てきますが、それを一旦おいといて登録を続けましょう。メールアドレスとパスワードを設定したら、次の画面でチーム名も必須項目なのでデフォルトの「Your Team」のままにします:
「Next」を押したら、ダッシュボードに移転されます。
チームの仕組みはもうすでに出来上がっています
この画面でユーザー登録の時に作ったチームの名前を確認できます:
しかも、CanCanCanを使ってのAdmin、役割のロジックももう出来上がっています。自分が「Your Team」のメンバーになっていることを、左のTeam Members
のボタンを押して確認しましょう。
Team, Membership, Userモデルのデザイン
データベース設計の面でここは結構大きくて、もうどういう風にユーザーをチームに属させるかを考えなくていい構造になっています。具体的なことはここで割愛しますが、なぜこのデザインにしたかはBullet Trainのブログに詳しく書いていますので(英語)興味ある人はそちらを参照してください。
ザッと説明すると、複数のチームに属することができて、そのチームのメンバーになっていることを表すのが「Membership」モデルであって「User」モデルではないです。例えば、あるチームを作ったユーザーはそのチームからメンバーじゃなくなったとしても、他のユーザーがAdminとしてさえ残っていたら、そのチームはなくなりません。ただし、最後のAdminはチームから出ることはできません。
Super Scaffolding
最後に紹介したい機能はSuper Scaffoldingです。
実際にSuper Scaffoldingを実行している動画はこちらにあります
普通のScaffoldならこう書きますよね:
$ rails g scaffold Article team:references title:string body:text
でも、一つのモデルを他のモデルにネストする時って、やったことがある人は分かると思いますが、上手く動くようにこのコマンド以外に修正が必要なところは他にもあってちょっと面倒いですよね。でもSuper Scaffoldingでは二つのコマンドを打つだけで簡単に新しいモデルをネストすることができます:
# `scaffold`じゃなくて`model`というところで要注意
$ rails g model Article team:references title:string body:text
$ bin/super-scaffold crud Article Team title:string body:text
ここでサイド・バー・メニューにアイコンを入れますかーって聞かれるけど、これは一旦「N」と答えましょう:
Hey, models that are scoped directly off of a Team (or nothing) are eligible to be added to the sidebar. Do you want to add this resource to the sidebar menu? (y/N)
N
データベースのマイグレートをして...
$ rails db:migrate
これで終了。bin/dev
でまたサーバーを立ち上げてホーム画面に戻ると新規のArticleを作ることができます:
こんな感じです。
文字列以外に、ボタンや他のインプットも対応していますので、ホーム画面からCreative Conceptを作り、作ったCreative Conceptのページで「Add New Tangible Thing」を押すと、他にBullet Trainは何を提供してくれるか確認いただけます:
ここでいうTangible Thingはあくまでどのインプットを設定できるかを見せるためにあり、このモデル自体を隠すにはconfig/application.yml
にHIDE_THINGS: true
を書くとなくなります。
英語なのですが、ドキュメントはこちらです。
Pro版
Stripeによる決済、メール機能やKanbanボードなどもPro版で対応していますので、無料版を使って気に入った人はぜひPro版の詳細も確認してみてください。
最近オープンソースになりました!
3月25日をもって元々有料限定だったBullet TrainはオープンソースになったことがSin City Rubyで発表されたので、コントリビュートしたい人はぜひGitHubのレポジトリーにプルリクを送ってください。
最後まで読んでいただき、ありがとうございます。