@innovastudio/contentbox 1.5.59 → 1.5.61

package/public/contentbox/lang/en.js

@@ -468,6 +468,8 @@ _txt["AI-Disclaimer"] = "The feature you're about to use utilizes AI in some of
 "There may be instances where the results are not 100% accurate or may provide unexpected responses or information. " +
 "As a user, it's your responsibility to independently verify any information or results obtained through this AI-powered feature. " +
 "Our team is dedicated to continuously improving its performance and accuracy to enhance your experience.";
+_txt["No microphone found. Please activate your microphone and refresh the page."] = "No microphone found. Please activate your microphone and refresh the page.";
+
 
 
 //ContentBox.js
@@ -725,4 +727,5 @@ _txt["Oops! The response received is insufficient. Please try again."] = "Oops!
 _txt["Oops! The section includes \'Lorem ipsum\' text. To optimize the redesign, we suggest updating this placeholder text with actual content."] = "Oops! The section includes \'Lorem ipsum\' text. To optimize the redesign, we suggest updating this placeholder text with actual content.";
 _txt["Proceed with Redesign"] = "Proceed with Redesign";
 _txt["Save Section Style"] = "Save Section Style";
-_txt["Redesign with Saved Style"] = "Redesign with Saved Style";
+_txt["Redesign with Saved Style"] = "Redesign with Saved Style";
+_txt["Service Unavailable."] = "Service Unavailable.";

package/readme.txt

@@ -1,20 +1,99 @@
 ContentBox.js 5.5.6
 
-To get started, please see the documentation:
+To get started, please refer to the documentation:
 
 https://demo.innovastudio.com/docs/ContentBox.pdf
 
+
+To try the example:
+
+Copy all files into your localhost and open the following in your browser:
+
+    http://localhost/.../public/example.html
+
 or
 
-README.md
+    http://localhost/.../public/example.php (PHP example)
 
-For Source Code Package only: please see readme-sourcecode.txt
 
-To try the example:
+    NOTE:
+
+    - To use the AI Assistant:
+        1. Obtain the OpenAI API Key from https://openai.com
+        2. Update the 'sendcommand.php' file with your API Key:
+       
+            define('OPENAI_API_KEY', 'YOUR_API_KEY_HERE');
+
+    - For speech recognition (when dictation is enabled), the browser's built-in
+        speech recognition is used. However, certain browsers may not support this feature.
+        We recommend using Deepgram for browser compatibility and accuracy.
+        Obtain the Deepgram API Key from https://deepgram.com.
+        An example of using Deepgram is provided in the Node.js example below.
+
+    - The AI Assistant is an optional feature that you can enable or disable.
+        Please refer to the AI Assistant documentation:
+
+        https://demo.innovastudio.com/docs/AI-Assistant.pdf
+
+
+_____________________________________________
+
+
+To run the project (Node.js example):
+
+    1. Install the project dependencies:
+
+        > npm install
+
+        Note: To run this command, you need to have NPM installed.
+        Download & install NPM from https://nodejs.org/en/download/.
+
+    2. OPTIONAL: (if you want to use the AI Assistant feature)
+
+        Update the .env file with your OpenAI and Deepgram API Keys: 
+        - Obtain the OpenAI API Key from https://openai.com
+        - Obtain the Deepgram API Key from https://deepgram.com (optional. See note below.)
+
+    3. Run the project:
+
+        > npm start
+
+        A browser window will open with the ContentBox.js example running.
+
+
+    NOTE:
+
+    - The ContentBox initiation can be found in 'src/index.js'.
+
+    - The Node.js server code is in 'server.js'.
+
+    - Using Deepgram for speech recognition is optional but recommended.
+    Alternatively, you can use the browser's built-in speech recognition.
+    To use the browser's built-in speech recognition, just disable/remove
+    the 'speechTranscribeUrl' parameter when initiating the ContentBox (src/index.js).
+
+
+_____________________________________________
+
+
+If you have the ContentBox source code:
+
+- The source code is located in the 'src/contentbox/' folder.
+  When you run the project, you can try modifying the source code, and
+  the changes will be applied, and the browser will refresh automatically.
+
+- When finished, to build the JS code that you can use in production, run:
+
+    > npm run build
+
+  The minified JS will be generated in the folder: 'public/contentbuilder/contentbuilder.min.js'.
+  You can test it by opening, for example, 'public/example.html'.
+  If you're using Visual Studio Code, right-click on the 'example.html' file and select "Open with Live Server".
+
+- To build CSS from SCSS files, run:
 
-Copy all files into your localhost and open: 
+    > npm run scss
 
-http://localhost/.../public/example.html
 
 _____________________________________________
 SUPPORT: