Shortcake導入ガイド


Shortcake導入ガイドです。ブラウザに表示するところまで、サーバの準備から順に説明します。

導入にあたっての注意事項

このページで説明する導入手順は、ひとまず起動するところまで始めたい人のための説明になります。基本的にはcakephpですので、cakephpの導入方法をご存じの方は、最後のshortcake設定ファイルの部分だけご確認ください。

また、ソースコードリポジトリの導入、CI(継続的インテグレーション)、ユニットテストというような一般的なソフトウェア開発の方法については、はしょってます。本格的に始めるようになったら必要なところからはじめればよいでしょう。

サーバ環境の準備

ドメインの取得

お名前.com等でドメインを取得します。Webサービスの顔になるドメインですので、よく考えて決めましょう。

レンタルサーバ

手っ取り早くスタートするにはレンタルサーバで運用するのが場合、近道です。以下のスペックを満たすレンタルサーバを準備してください。

  • cakephpが動作すること
  • MySQL等のデータベースが使える。
  • SSLが使えること(SNSログインに必要になります)
  • 独自ドメインが使えること(サブドメインを作れることが望ましい。)
  • smtpでメール送信ができること

どこのレンタルサーバでもよいですが、当サイトでも動作検証しているXserverがおすすめです。

AWSのようなクラウド環境については、自分で環境構築できる場合には問題ありませんが、とりあえず立ち上げを急ぎたいという方は、全部そろっているレンタルサーバをお勧めします。AWSの場合、メールサーバをはじめとして、すべての環境を全てを自分で構築する必要が出てきます。そこに時間をかけるのは、作ったWebサービスが軌道に乗ってからでよいのではないでしょうか。

ドメインを設定する

DNS設定の方法は、お名前.comやレンタルサーバのマニュアルを見ましょう。

サブドメインの作成

ShortcakeでWebサービスを作る場合、5つのサブドメインを作成します。

取ったドメインが「example.com」だとすると、サブドメインは以下のようになります。もちろん、例ですので、違う名前でもかまいません。

開発環境については、まぁ必須ではないので、今はいらない、という選択肢もないことはないです。

区分 サブドメイン 用途
開発用 dev.example.com 開発環境Webサービス
dev_dashboard.example.com 開発環境ダッシュボード
本番用 app.example.com 本番Webサービス用
dashboard.example.com ダッシュボード
example.com トップページ用(Wordpressを配置する想定)

WordPressが不要な場合は、Webサービスがトップページになるように配置してください。また、example.com/ にWorpressを配置して、example.com/app/にShortcakeを配置、あるいは逆にexample.com/にShortcakeを配置し、example.com/blog/にWorpressを配置する方法もあります。(これについては、後日、記載する予定です。)

メールアドレスの作成

Shortcakeでは、システム側からメールを送信する機能(会員登録時やパスワード復旧の時)と、ユーザから問い合わせなどで送信される2つの使い方をします。用途ごとにアドレスを分けてもかまいませんし、共通のアドレスを使ってもかまいません。

レンタルサーバのコントロールパネルで、会員登録時やパスワード復旧の時にシステム側から送信するメールの送信元アドレスを作成します。no-reply@example.comとか、info@example.comのようなものでOKです。問い合わせ受信用に使うメールアドレスは、実際に受信できるメールアドレスにしてください。

SNS Oauthの登録

SNSでログインするためには、SNSにAPIキーの登録が必要です。Shortcakeは、Facebook、Twitter、LINEに対応してるので、それぞれ登録してください。対応が不要なSNSは、ログイン画面のボタンを消してください。そのほかのSNSに対応するためには、Opauthマニュアルをご覧ください。

Facebook

Twitter

LINE

Shortcakeの導入

最後のShortcake設定以外はcakephp導入手順と同様です。

データベースの作成

データベース名、ユーザ名、パスワードを覚えておきましょう。

ソースコードの配置

設定ファイル(cakephp)

cakephpの初期設定ファイルをご自分の環境に合わせて修正してください。以下のファイルを修正する必要があります。詳細はcakephpの導入マニュアルをご覧ください。

  • bootstrap.php
  • database.php
  • email.php
  • routes.php

設定ファイル(Shortcake)

app/Config/shortcake.php

初期表示確認

ブラウザを開くとアプリが動いていると思います。ログイン画面から設定確認用の表示を削除しましょう。

動作確認

一通りの画面を確認したいところですが、ひとまず以下の3機能を試してみるとよいでしょう。

会員登録

会員登録し、ログインしてみましょう。

SNS機能の確認

SNSから会員登録し、ログインしてみましょう。

問い合わせ

問い合わせフォームから、メールを送信してみましょう。設定したメールアドレスにメールが届けば問題ありません。

最低限のカスタマイズをする

ロゴ画像のアップロード

レイアウトや配色などのデザインは後回しにしてもよいですが、ひとまずロゴだけでも変えておきましょう
。ロゴ画像がない場合は、サービス名称だけでかまいません。

固定コンテンツの書き換え

以下のページを、自分のサービスにあうようにに書き換えてください。不要なページはリンクから外してしまいましょう。

ファイルは、app/View/Pages/にある各ctpファイルです。

  • 使い方
  • プライバシーポリシー
  • よくある質問
  • 運営者情報
  • 特定商取引に関する表示

これで完成です。あとは自分のアイデアを組み込んで、楽しいWebサービスを作りましょう