From bb403576e8de3821e7d17311857943adc325928c Mon Sep 17 00:00:00 2001 From: sasangachathumal Date: Thu, 8 Aug 2024 13:19:46 +0530 Subject: [PATCH] readme udated. --- README.md | 60 +++++++++++++++++++++++++++---------------------------- 1 file changed, 29 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 88591bef..33ed0a76 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,24 @@ - Ionic 7 - Angular 15 +- stable Node version (20 or above) that comatible with Angular 15 and ionic 7. + +## Installation + +- Clone the repository and navigate to the folder. +- Run `npm install` to install necessary packages +- Duplicate `environment.local.ts` under the `src/environments/` folder and rename it to `environment.ts` +- Download the `cutie-environment.ts` file [Link](https://drive.google.com/drive/folders/1qggIJIib_S36ohZB1DJ9m50dGUxQ5Pzx?usp=sharing). +- Update your `environment.ts` file values with `cutie-environment.ts` file values. +- Run `npm run start` to start a development server on your local, and calling stage.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` +3. This will not make any API calls and use demo data. ## Development @@ -15,7 +33,7 @@ 1. Ignore the `.localsegment` error during compilation (it's for devops purpose) 1. Start coding! -### Sandbox API environment (option 1) +### Sandbox/Stage API environment (option 1) 1. Copy the "me" object from the localStorage from our app or core-admin 1. Paste it in your running local cutie-app's localStorage with the same key ("me") @@ -24,44 +42,24 @@ 1. For example, `https://localhost:4202/overview-only` will redirect you to *overview-only* route. 1. You would not redirected and will get stuck in `https://localhost:4202` when there is no relative URL appended. -### Sandbox API environment (option 2) +### Sandbox/Stage API environment (option 2) 1. Follow this URL format: https://localhost:4202/?redirect=overview-only&jwt={OUR-APP-APIKEY} 1. Get the APIKEY from the already authorised app user localStorage or HTTP header and replace {OUR-APP-APIKEY} with the obtained APIKEY 1. You'll be redirect to the specified "redirect" destination. -## Installation +### Redirect options -- 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 +- **/chat-only** - for admin chat components. +- **/overview-only** - for admin home components. +- **/templates** - for template libarary. +- **/metrics** - for metrics components. -To run the demo version of CUTIE on local +disable for now -1. Go to `src/environments/environments.ts`, change `demo: false` to `demo: true` -1. Run `npm run start` to start a local server on `localhost:4202` +- **/onboarding** - user onboarding MVP. +- **/progress-only**. ## Capacitor -We use Capacitor to make the app work on Android, IOS & Electron - -### Android - - install [JAVA 8 JDK](https://www.oracle.com/technetwork/java/javaee/downloads/jdk8-downloads-2133151.html) - - install [Android Studio](https://developer.android.com/studio/index.html) - - 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` +We have Capacitor configaration setup to make the app work on Android, IOS & Electron. **But Cutie app is not develoing for mobile**