create-pb-tririga-react-app 1.0.3 → 1.0.5

package/README.md

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

package/index.js

@@ -49,4 +49,6 @@ pkgJson.name = projectName;
 fs.writeFileSync(pkgJsonPath, JSON.stringify(pkgJson, null, 2));
 
 console.log(`Success! Created ${projectName}.`);
-console.log(`See Readme.md in the project folder for instructions on how to get started.`);
+console.log(`cd ${projectName}`);
+console.log(`pnpm install`);
+console.log(`pnpm run dev`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-pb-tririga-react-app",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "Scaffold a TRIRIGA React app with Vite and TypeScript",
   "main": "index.js",
   "bin": {
@@ -11,7 +11,12 @@
     "template",
     "README.md"
   ],
-  "keywords": ["tririga", "react", "vite", "scaffold"],
+  "keywords": [
+    "tririga",
+    "react",
+    "vite",
+    "scaffold"
+  ],
   "author": "Your Name",
   "license": "ISC"
 }

package/template/README.md

@@ -4,22 +4,21 @@ This is a template for building IBM TRIRIGA UX applications using React, TypeScr
 
 ## Getting Started
 
-1.  **Install Dependencies**
+1.  **Install pnpm** (If not already installed)
     ```
-    npm install
+    npm install -g pnpm
     ```
 
-2.  **Configure Environment**
-    Copy `.env.example` to `.env` and update the values for your local development and deployment settings.
+2.  **Install Dependencies**
     ```
-    cp .env.example .env
+    pnpm install
     ```
 
-3.  **Run Locally**
+3.  **Configure Environment**
+    Copy `.env.example` to `.env` and update the values for your local development and deployment settings.
     ```
-    npm run dev
+    cp .env.example .env
     ```
-    Open [http://localhost:5173](http://localhost:5173) (or the port shown in terminal).
 
 ## Deployment
 
@@ -27,17 +26,20 @@ To deploy to a TRIRIGA environment:
 
 1.  **Install Depoyment Tool** (If not already installed globally)
     ```
-    npm install -g @tririga/tri-deploy
+    pnpm 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**
     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, appExposedName) to match your application's configuration in TRIRIGA.
+
+4.  **Run Deployment**
     The view name will be taken from the `name` field in `package.json`.
     ```
-    npm run build:deploy
+    pnpm run build:deploy
     ```
 
 ## Browser Support & Polyfills

package/template/package.json

@@ -9,7 +9,7 @@
     "lint": "eslint .",
     "preview": "vite preview",
     "deploy": "dotenv -- cross-var tri-deploy -t %TRI_URL% -u %TRI_USER% -p %TRI_PASSWORD% -v \"$npm_package_name\" -d dist -w",
-    "build:deploy": "npm run build && npm run deploy"
+    "build:deploy": "pnpm run build && pnpm run deploy"
   },
   "dependencies": {
     "@babel/runtime": "^7.26.0",

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
   };