create-pb-tririga-react-app 1.0.4 → 1.0.6

package/README.md

@@ -23,7 +23,4 @@ npx create-pb-tririga-react-app my-tririga-app
 Once created:
 
 1. `cd my-tririga-app`
-2. `npm install -g pnpm`
-2. `pnpm install`
-3.  Update configuration files (see `README.md`)
-4. `pnpm run build:deploy`
+2.  Follow setup instructions in the project `README.md`

package/index.js

@@ -49,6 +49,4 @@ pkgJson.name = projectName;
 fs.writeFileSync(pkgJsonPath, JSON.stringify(pkgJson, null, 2));
 
 console.log(`Success! Created ${projectName}.`);
-console.log(`cd ${projectName}`);
-console.log(`pnpm install`);
-console.log(`pnpm run dev`);
+console.log(`cd ${projectName} and see the Readme.md inside the project folder for further instructions.`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-pb-tririga-react-app",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "Scaffold a TRIRIGA React app with Vite and TypeScript",
   "main": "index.js",
   "bin": {

package/template/README.md

@@ -15,31 +15,40 @@ This is a template for building IBM TRIRIGA UX applications using React, TypeScr
     ```
 
 3.  **Configure Environment**
-4.  **Run Locally**
+    Copy `.env.example` to `.env` and update the values for your local development and deployment settings.
     ```
-    pcp .env.example .env
+    cp .env.example .env
     ```
 
-3.  **Run Locally**
-    ```
-    npm run dev
-    ```
-    Open [http://localhost:5173](http://localhost:5173) (or the port shown in terminal).
-
 ## Deployment
 
 To deploy to a TRIRIGA environment:
 
 1.  **Install Depoyment Tool** (If not already installed globally)
     ```
-    pnpm install -g @tririga/tri-deploy
+    npm install -g @tririga/tri-deploy
     ```
     *Note: If you prefer not to install globally, you can add `@tririga/tri-deploy` to your devDependencies.*
 
 2.  **Configure Credentials**
+    Copy `.env.example` to `.env` and update the values for your deployment settings.
+    ```
+    cp .env.example .env
+    ```
     Ensure your `.env` file has the correct `TRI_URL`, `TRI_USER`, and `TRI_PASSWORD`.
 
-3.  **Run Deployment**
+3.  **Configure tririgaService.js file**
+    Update the TriAppConfig values `modelAndView` and `appExposedName` to match your app configuration in TRIRIGA.
+    Example: 
+    `modelAndView: "myReactApp",`
+    `appExposedName: "myReactApp",`
+
+3.  **Configure vite.config.ts file**
+    Update the base value to match your application's exposed name in TRIRIGA. 
+    Example: 
+    base: '/app/myReactApp/',
+
+4.  **Run Deployment**
     The view name will be taken from the `name` field in `package.json`.
     ```
     pnpm run build:deploy

package/template/src/services/tririgaService.ts

@@ -26,16 +26,14 @@ export async function initTriAppConfig(): Promise<TriAppConfig> {
   if (segments[0] === 'app' && segments[1]) {
     appPath = `/app/${segments[1]}/`;
   }
-  // Assume view name matches exposed name valid for standard deployments
-  const viewName = segments[1] || 'unknownView';
   
   const config: TriAppConfig = {
     instanceId: "-1",
     tririgaUrl: window.location.origin,
     contextPath: "/app",
-    modelAndView: viewName,
+    modelAndView: "modelAndView", //update to match your TRIRIGA application
     appPath: appPath,
-    appExposedName: viewName,
+    appExposedName: "appExposedName", //update to match your TRIRIGA application
     sso: false
   };
   

package/template/vite.config.ts

@@ -3,7 +3,7 @@ import react from '@vitejs/plugin-react'
 
 // https://vite.dev/config/
 export default defineConfig({
-  // Use relative base path for portability across environments
-  base: './', 
+   // Base path must match the TRIRIGA view name /app/<appName>/
+  base: '/app/appName/', 
   plugins: [react()],
 })