Practera-cutie

GitHub Page TODO: No unit test, sonar test yet for cuite-app

Requirements

• Ionic 7
• Angular 15

Development

1. To run this project locally, start with demo:true (in environment.ts)
2. Go to https://localhost:4202/auth/demo (the SSL must not be omitted) to get authorised locally
3. Ignore the .localsegment error during compilation (it's for devops purpose)
4. Start coding!

Sandbox API environment (option 1)

1. Copy the "me" object from the localStorage from our app or core-admin
2. Paste it in your running local cutie-app's localStorage with the same key ("me")
3. There is no content in the root "/"
4. relative-url must be added after the https://localhost:4202/ in order to see the content that you expect to see
5. For example, https://localhost:4202/overview-only will redirect you to overview-only route.
6. You would not redirected and will get stuck in https://localhost:4202 when there is no relative URL appended.

Sandbox API environment (option 2)

1. Follow this URL format: https://localhost:4202/?redirect=overview-only&jwt={OUR-APP-APIKEY}
2. Get the APIKEY from the already authorised app user localStorage or HTTP header and replace {OUR-APP-APIKEY} with the obtained APIKEY
3. You'll be redirect to the specified "redirect" destination.

Installation

• Run npm install to install necessary packages
• Duplicate environment.local.ts under the src/environments/ folder and rename it to environment.ts
• Run npm run start to start a development server on your local, and calling sandbox.practera.com for API

Demo

To run the demo version of CUTIE on local

1. Go to src/environments/environments.ts, change demo: false to demo: true
2. Run npm run start to start a local server on localhost:4202

Capacitor

We use Capacitor to make the app work on Android, IOS & Electron

Android

• install JAVA 8 JDK
• install Android Studio
• run npx cap open android to open the project

IOS

• Xcode 9 or above version is needed
• install the Xcode Command Line tools (either from Xcode, or running xcode-select --install)
• run sudo gem install cocoapods to install cocoapods
• run pod repo update to update Cocoapods
• run npx cap open ios to open the project in Xcode

Electron

• run npm run electron:start to launch the Electron instance

After code changes, in order to test the code on Android/IOS/Electron, run npm run build.

If there are dependency changes, run npx cap sync