Skip to content

Latest commit

 

History

History
118 lines (83 loc) · 3.49 KB

README.md

File metadata and controls

118 lines (83 loc) · 3.49 KB
Raw

Sample petclinic mobile application for CUBA backend. Built with:

Step by Step Guide

Preparing CUBA Application

We'll be using petclinic sample.

git clone https://github.com/cuba-platform/cuba-petclinic.git

Add REST API Addon

Open the project in CUBA Studio and add REST API addon.

In our case you can just switch to with-rest-api branch:

git checkout with-rest-api

Setup Security

Once REST API addon is enabled you must configure security and keep it up-to-date.

Setup Studio

For a convenience of using SDK generator toggle Old Studio integration enabled in CUBA plugin settings in IntelliJ.

Creating React Native Application

Setup the Environment

You should have Node.js 12+ installed on your system. Optionally you may also install Yarn. This particular sample project uses Yarn instead of npm.

Install Expo CLI:

npm install -g expo-cli

Create a New React Native Project

expo init

This will prompt you with several options. For a simplicity we'll be using managed workflow (more info about workflows and TypeScript to get an advantage of strong typing. So select:

> blank (TypeScript)

Specify the name and the slug (e.g. petclinic) of your mobile app. The app should be available in the ./slug subdirectory

cd petclinic

The next step is crucial to make CUBA's cli work: specify name in package.json of newly created application.

Now you will be able to launch your newly-created app in web:

yarn web

In order to launch your app in Android/iOS simulators you will need to set up corresponding SDKs on your machine. Then it will be possible to launch the app as simple as

yarn android

or

yarn ios

Read more about Expo's features and abilities in the official documentation

Generating CUBA TypeScript SDK

Install gen-cuba-front Tool

npm install @cuba-platform/front-generator

Generate TypeScript SDK

In your React Native app create cuba directory:

mkdir cuba
cd cuba

Open your backend (CUBA) app in Studio/IntelliJ IDEA and run SDK generator:

gen-cuba-front sdk:all

It should prompt you with CUBA projects currently opened in Studio. Select the desired project. The SDK should be generated in the current directory (cuba).

The SDK contains types of Entities, Enums, Views and exposed via REST middleware services.

Add CUBA REST JS Library

In order to communicate with REST API add @cuba-platform/rest library:

yarn add @cuba-platform/rest

The library uses base64 conversion which is absent on mobile devices RN runtime. For this demo project to provide it for mobile devices we register globally our own implementation, see util/base64.ts.

State Management

CUBA provides experimental MobX based primitives for working with data. Install mobx and @cuba-platform/react-core:

yarn add mobx@4 mobx-react@5 @cuba-platform/react-core

See usage example