この記事には
今回作るアプリケーションの仕様書を記載しています。
今回作るアプリケーション
| title | name |
|---|---|
| アプリ名 | Rails6とNuxt.jsで作るユーザーJWT認証付きシングルページアプリケーション |
| OS | macOS |
| 開発環境 | Docker |
| サーバーサイド | Rails apiモード |
| フロントエンド | Nuxt.js spaモード |
| データベース | postgreSQL |
| 本番環境 | Heroku |
| バージョン管理 | GitHub |
バージョン
| tool | version |
|---|---|
| macOS | 10.15 |
| Docker | 19.03以上 |
| DockerComopse | 1.25.5 |
| Rails | 6.0系 |
| Nuxt.js | 2.14以上（ブログ記事ではv2.13を使用） |
Dockerコンテナ設計
開発環境の全体像
GitHubリポジトリ管理
本番環境へのデプロイ設計
ユーザーテーブル設計
| カラム | 型 | デフォルト | NULL | 長さ | 内容 |
|---|---|---|---|---|---|
| name | String | false | 30 | ユーザー名 | |
| String | false | 255 | メースアドレス | ||
| password_digest | String | false | 72 | パスワード | |
| activated | Boolean | false | false | メール認証フラグ | |
| admin | Boolean | false | false | 管理者フラグ |
-
name... ユーザー名。これは一意性のアカウント名ではなくニックネーム的な扱いです。
入力必須、30文字制限を付けます。
-
email.. ユーザーメールアドレス。会員登録、ログインに使用します。
-
password... ユーザーパスワード。会員登録、ログイン、ユーザー削除などの重要な操作に使用します。
-
activated... メール認証フラグ。メールが認証されたユーザーは
trueになります。 -
admin... 管理者フラグ。今回は使用しませんが、管理者だけが行える操作、管理画面の表示切り替えなどに使います。
ユーザー名の考え方
TwitterやQiita、GitHubなどユーザーがコンテンツを不特定多数に公開できるようなWebサービスの場合、ユーザー名を一意性のユーザーIDとして扱った方が良いでしょう。
他のユーザーがIDで検索することができたり、メールアドレスに変えてログインすることができたり、マイページのURLとして利用することができたり。
利便性が高まります。
ただ今回は、プライベートな業務アプリを想定しているため、個人を認識するためだけに使用します。
ユーザー名に一意制約や英数字必須などのバリデーションは設けません。
このように、どんなアプリケーションを作りたいのかでユーザー名の使用目的も変化します。
自分が作りたいサービスに良く似たサービスを見つけ、研究することをおすすめします。
ユーザー認証設計
今回のユーザー認証設計はこの手順になります。
- ユーザーが新規会員登録を行います。
- ユーザーテーブルに
activated: falseの状態で保存されます。 - 登録されたメールアドレスに期限付きの認証用URLを送信します。
- 期限以内に認証用URLをクリックした場合
activated: trueになり、認証を完了します。
- 認証用URLの期限が切れた場合
- ユーザーは1に戻り、もう一度会員登録を行います。
activated: falseの状態のユーザーはテーブルに保存されたままになります。
メールアドレスの一意性
今回のユーザー認証設計の場合、emailカラムに一意制約を付けると期限切れのユーザーは二度と新規会員登録できなくなります。
そこで同じメールアドレスは何度でも保存可能とし、認証済みのユーザーが既に存在する場合は保存不可とします。
これにより認証済みメールアドレスの一意性を保ちます。
← Prev
Next →
あなたの力になれること
私自身が独学でプログラミングを勉強してきたので、一人で学び続ける苦しみは痛いほど分かります。そこで、当時の私がこんなのあったら良いのにな、と思っていたサービスを立ち上げました。周りに質問できる人がいない、答えの調べ方が分からない、ここを聞きたいだけなのにスクールは高額すぎる。そんな方に向けた単発・短期間メンターサービスを行っています。
独学プログラマのサービス
Udemyの投稿
1
【お知らせ】UdemyでRails × Nuxt.jsの動画を公開することになりました
2
アプリケーション仕様書
3
このカテゴリーの歩き方(まずはここをチェック)
4
(Docker+Rails6+Nuxt.js+PostgreSQL)=>Heroku 環境構築~デプロイまでの手順書
1
Docker for Macをインストールする手順
2
分かるDocker解説。仮想環境・コンテナ・Dockerイメージ・Dockerfileとは何か?
3
分かるDocker解説。DockerComposeとは何か?
1
【Docker+Rails6+Nuxt.js】今回作成するアプリの開発環境の全体像を知ろう
2
【MacOS】Homebrew経由でGitをインストールする方法
3
Rails6を動かすAlpineベースのDockerfileを作成する(AlpineLinuxとは何か)
4
Nuxt.jsを動かすAlpineベースのDockerfileを作成する(C.UTF-8とは何か)
5
.envファイルを使ったdocker-compose.ymlの環境変数設計
6
Rails6・Nuxt.js・PostgreSQLを動かすdocker-compose.ymlファイルを作成する
7
docker-compose.ymlを使ってRails6を構築する(PostgreSQLパスワード変更方法)
8
docker-compose.ymlを使ってNuxt.jsを構築する
1
複数プロジェクトで行うGit管理の全体像を理解しよう(Gitサブモジュール解説)
2
【Git】既存の子ディレクトリをサブモジュール管理に変更する手順
3
【GitHub】秘密鍵の生成・公開鍵を追加・SSH接続するまでを画像で分かりやすく
4
【GitHub】リモートリポジトリの追加・サブモジュールのリンク設定を行う
1
【Rails6】"Hello" jsonを返すコントローラを作成する
2
【Nxut.js】axiosの初期設定を行う(baseURL・browserBaseURLを解説)
3
【Rails6】Gem rack-corsを導入してCORS設定を行う(オリジン・CORSとは何か)
1
デプロイ準備。Herokuへ新規会員登録を行いHerokuCLIをインストールする
2
heroku.yml解説編。Docker環境のRails6をHerokuにデプロイする(1/2)
3
HerokuCLI-manifestのデプロイ解説編。Docker環境のRails6をHerokuにデプロイする(2/2)
4
Dockerfile解説編。Docker環境のNuxt.jsをHerokuにデプロイする(1/2)
5
デプロイ完結編。Docker環境のNuxt.jsをHerokuにデプロイする(2/2)
1
【Rails6】application.rbの初期設定(タイムゾーン・I18n・Zeitwerk)
2
【Rails6】モデル開発に必要なGemのインストールとHirb.enableの自動化
3
【Docker+Rails】A server is already running. Check /tmp/pids/server.pidエラーの対応
4
【Docker】<none>タグのイメージを一括削除する & Rails .gitignoreの編集
1
Railsユーザーモデル作成。テーブル設計・ユーザー認証設計を理解する
2
Railsユーザーモデルのバリデーション設定(has_secure_password解説)
3
Railsバリデーションエラーメッセージの日本語化(ja.yml設定方法)
4
EachValidatorクラスのカスタムバリデーション設定(Rails6/lib以下読込)
5
Rails環境ごとにSeedデータ切り替えるseeds.rbの書き方
6
Rails6から導入された並列テストを理解する
7
Railsユーザーモデルバリデーションテスティング(name/email/password)
8
Nuxt.jsからRailsのユーザーテーブルを取得しHerokuにデプロイする
1
【Nuxt.js2.13超解説】バージョンアップ手順と6つの新機能+2つの変更点
2
Docker AlpineベースのNode.js上で動くNuxt.jsにVuetifyを導入する
3
VuetifyにカスタムCSSを導入してオリジナルブレイクポイントを作る
4
Nuxt.jsにnuxt-i18nを導入して国際化に対応する
1
Nuxt.jsのレイアウト・ページ・コンポーネントの役割を理解しよう
2
Nuxt.js ウェルカムページを構成するコンポーネントファイル群を作成しよう(1/4)
3
Nuxt.js ウェルカムページにアイキャッチ画像・アプリ名・メニューボタンを表示しよう(2/4)
4
Nuxt.js addEventListenerでスクロールを検知しツールバーの色を変化させよう(3/4)
5
Nuxt.js ウェルカムページをレスポンシブデザインに対応させよう(4/4)
6
Nuxt.js 会員登録ページのレイアウトファイルを作成しよう(1/4)
7
Nuxt.js 名前、メール、パスワードのコンポーネントファイルを作成しよう(2/4)
8
Nuxt.js 親子コンポーネント間の双方向データバインディングを実装する(3/4)
9
Nuxt.js Vuetifyのv-text-fieldを使った会員登録フォームのバリデーション設定(4/4)
10
Nuxt.js ログインページ実装とHerokuデプロイまで(router. replaceとpushの違いとは)
1
Nuxt.js ログイン後のツールバーを作成しよう(inject解説)
2
Nuxt.js アカウントメニューページ・ログアウト機能を実装しよう(nuxt-child解説)
3
Nuxt.js ログイン後のトップページにプロジェクト一覧を表示しよう
4
Nuxt.js プロジェクトページにVuetifyのナビゲーションドロワーを追加しよう
5
Nuxt.js paramsIDからプロジェクトを検索してVuexに保存しよう
1
JWTとは何か?(ruby-jwtのインストール)
2
【Rails×JWT】ログイン認証解説とJWT初期設定ファイルの作成
3
【Rails×JWT】トークン発行とデコードを行うAuthTokenクラスの作成
4
【Rails×JWT】 ログイン判定を行うAuthenticatorモジュールの作成
5
【Rails×JWT】UserクラスからJWTを扱うTokenizableモジュールの作成
6
【Rails×JWT】AuthTokenクラスとAuthenticatorモジュールをテストする
7
【Rails×JWT】JWTをCookieに保存するログインコントローラーの実装
8
【Rails×JWT】ログインコントローラーのテストとHerokuデプロイ
1
【Rails×Nuxt.js】クロスオリジン通信でのCookie共有設定
2
【Nuxt.js】Railsからのログイン成功レスポンスをVuexに保存する
3
【Nuxt.js】ローカルストレージの有効期限を暗号化する(crypto-js解説)
4
【Nuxt.js】JWT有効期限内のユーザーをログインしたままにする実装
5
【Nuxt.js】ログイン前後のリダイレクト処理をミドルウェアで実装する
6
【Nuxt.js】ログイン失敗時のトースターをグローバルイベントとして作成する
7
【Nuxt.js】エラーページを作成する
8
【Rails×Nuxt.js】デモプロジェクトの作成とHerokuデプロイ(ログイン認証完)
1
【Rails×Nuxt.js】SafariのクロスサイトCookie保存拒否に対応する