Skip to content

Latest commit

 

History

History
73 lines (45 loc) · 3.38 KB

README.md

File metadata and controls

73 lines (45 loc) · 3.38 KB
Raw

Turbo Native Rails back-end example app

This example app includes everything you need to get up and running with the Jumpstart Pro iOS template.

You can start with this repository as a template for your Rails codebase or copy/paste the needed code into your existing app.

Overview

The app is a blogging example with limited functionality. You can perform CRUD operation on Post objects and sign in/out via Devise.

Creating, updating, or deleting blog posts requires you to be signed in.

Installation

To run the example, perform the following:

  • Clone the repo
  • run bundle install
  • run yarn
  • run rails db:create
  • run rails db:migrate
  • run bin/dev
    • This will install foreman the first time if you dont have it already installed. If this is the case you will need to run bin/dev again
  • Visit localhost:3000 in your browser, app should be running

Path Configuration

The PathConfigurationsController configures the settings and tabs for your app.

Dynamic native tabs

Adding more hashes under the tabs: key will add new native tabs to the app the next time it is launched.

See the Jumpstart Pro iOS documentation on more information on more configuration options.

Authentication

The Turbo Native client requires both cookie- and token-based authentication. Cookies are used for web views and tokens are used for authenticated HTTP requests.

Signing in

To ensure the client can persist these tokens a new endpoint is required. POSTing to /api/v1/auth with the user's email and password signs them in, sets the cookie header (Set-Cookie), and returns the authentication token. These are both then persisted to the device in the iOS template.

Token authentication is handled via has_secure_token on the User model.

Signing out

Like signing in, signing out also requires a special workflow so the iOS client can remove the persisted tokens.

Sending a DELETE request to /api/v1/auth signs the user out (resets the cookies) and deletes the associated notification token.

HTML links to sign out are "trapped" via a Stimulus controller to ensure the request is sent from the app. See TurboNative-SignOutController on how this click is hijacked and a JavaScript message is sent to the iOS app to kick off the flow.

Push notifications

After successfully signing in the app POSTs the device's notification token to /api/v1/notification_tokens (with the user's permission). This is persisted to the NotificationToken model and associated with the User.

An example push notification is set up powered by Noticed (and Apnotic). See NewPostNotification.

To get this working in your app you will need to follow a few steps.

  1. Ensure that you have an active Apple Developer Program subscription.
  2. Register your app's bundle identifier making sure to check APNS (Push Notifications) capability.
  3. Generate an APNs .p8 file from your Apple Developer portal.
  4. Copy the generated .p8 file to config/certs/ios/apns.p8.
  5. Add the following credentials to the necessary environments.
ios:
  key_id: # Shown before you download the .p8 key.
  team_id: # In the upper-right of App Store Connect.
  bundle_identifier: # The dot-separated identifier of your app, configured in Xcode.