Skip to content

Latest commit

 

History

History
107 lines (89 loc) · 4.51 KB

README.md

File metadata and controls

107 lines (89 loc) · 4.51 KB
Raw

CARTE

CARTEは、「KARTE for App」のSDKを検証するためのサンプルアプリケーションです。
このサンプルアプリケーションでは、KARTE for App SDKの基本的な機能を試す事が可能です。

Requirements

  • iOS 12.0+
  • Xcode 10.2+
  • Swift 5+
  • Node.js 10.10+

Installation (Firebase)

このサンプルアプリケーションでは、バックエンドに「Firebase」を採用しております。
そのため事前にFirebaseのセットアップが必要になります。

Features of the required Firebase.

  • Authentication
  • Cloud Firestore
  • Cloud Messaging
  • Cloud Storage
  • Hosting

Authentication

以下のログインプロバイダを有効にしてください。

  • Email and password based authentication
  • Anonymous auth

Cloud Firestore

以下の通りセキュリティルールを設定してください。

service cloud.firestore {
  match /databases/{database}/documents {
    match /{document=**} {
      allow read, write: if request.auth.uid != null;
    }
  }
}

Cloud Messaging

「APNs Auth Key」を設定する必要があります。
詳細はこちらをご覧ください。

Cloud Storage

デフォルトバケットを作成する必要があります。 Firebaseコンソールにアクセスして、デフォルトバケットを作成してください。

Hosting

Hostingを利用するためには、Firebase CLIが必要になります。
こちらを参考に設定を行ってください。

また以下のHTMLファイルに、KARTEの計測タグを設置する必要があります。
計測タグの設置方法に関しては、こちらをご覧ください。

  • hosting/public/order.html
  • hosting/public/complete.html

Set the initial data.

サンプルアプリケーションを利用するために、事前に初期データをFirebaseに投入する必要があります。

初期データ投入スクリプトは node.js で書かれており、いくつかのパッケージに依存しています。
スクリプト実行前に、依存パッケージをインストールしてください。

cd carte/firebase/fixture
npm install

carte/firebase/fixture ディレクトリに、こちらから取得したサービスアカウントキーを配置してください。
その上で、スクリプト（carte/firebase/fixture/index.js）を修正します。

  • 2行目の <YOUR_SERVICE_ACCOUNT_KEY> 部分をファイル名に置き換える
  • 7行目の <YOUR_PROJECT_ID> 部分をFirebaseプロジェクトIDに置き換える

以下のコマンドを実行して、初期データの投入を行ってください （コマンドの実行には Node.js v10.10 以上が必要です）

cd carte/firebase/fixture
node index.js

引き続き、以下のコマンドを実行して、HTMLコンテンツのホスティング処理を行なってください。

cd carte/firebase/hosting
firebase deploy

Installation (Application)

サンプルアプリケーションをビルドするためには、CocoaPods等のツールを事前にインストールしておく必要があります。
以下のコマンドを実行してください。

cd carte/CARTE
bundle install --path vendor/bundler

サンプルアプリケーションは、いくつかのライブラリに依存しています。
以下のコマンドを実行して、依存ライブラリのインストールを行なってください。

cd carte/CARTE
bundle exec pod install

サンプルアプリケーションを実行するには、数カ所コードの修正を行う必要があります。

  1. CARTE/CARTE/Configuration.swift の修正 (ソースコードコメントを参考に以下3箇所を修正)
  • applicationKey
  • webContentHostingURL
  • deeplinkBaseURL
  1. CARTE/CARTE ディレクトリ直下に GoogleService-Info.plist を配置
  • GoogleService-Info.plist の取得については、こちらをご覧ください。

Xcodeを起動して、「⌘ + R」キーを押しビルドを行います。
各種設定が問題なく行われていれば、ビルドが成功し、アプリケーションが起動するはずです。