@innovastudio/contentbox 1.5.87 → 1.5.89

package/readme.txt

@@ -1,131 +1,144 @@
-ContentBox.js 5.6.1
+ContentBox.js 5.6.2
 
-To get started, please refer to the documentation:
+Documentation:
 
     https://demo.innovastudio.com/docs/ContentBox.pdf
 
+    https://demo.innovastudio.com/docs/AI-Assistant.pdf (AI Assistant documentation)
 
-To try the example:
 
-Copy all files into your localhost and open the following in your browser:
+You can choose to run the HTML, PHP or JavaScript project examples:
 
-    http://localhost/.../public/example.html
+A. To try the HTML example:
 
-or
+    1. Unzip the project files:
 
-    http://localhost/.../public/example.php (PHP example)
+       - ContentBox/
 
+    2. Open terminal, go to the project directory and install the required server dependencies.
+       The example is using Node.js server.
 
-or run the example project:
-
-    1. Install the project dependencies:
+        > cd ContentBox
 
         > npm install
 
-        Note: To run this command, you need to have NPM installed.
-        Download & install NPM from https://nodejs.org/en/download/.
+            Note: To run this command, you need to have NPM installed.
+            Download & install NPM from https://nodejs.org/en/download/.
+
+    3. Run the server:
+
+        > node server.js
+
+    3. Open from your browser:
+
+        http://localhost:8081/example.html 
+
+
+B. To try the PHP Example, open from your browser:
 
-    2. Run the project:
+    http://localhost/.../public/example.php
+ 
+    If you're using Visual Studio Code, you can use the PHP Server extension.
+
+
+C. To try the JavaScript project, install the dependencies and start the project:
+
+        > npm install
 
         > npm start
 
-        A browser window will open with the ContentBox.js example running.
+    A browser window will be opened with the example running.
 
-        - The ContentBox initialization can be found in 'src/index.js'.
-        - The Node.js server code is in 'server.js'.
+    Note:
+        The code for this project is:
+            
+            src/index.js
 
-NOTE:
+        The project is using Node.js server:
+
+            server.js
 
-- 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
+NOTE:
 
 - To use the AI Assistant:
     1. Obtain the OpenAI API key from https://openai.com.
     2. Update the .env file with your API key.
 
-       Alternatively, if you're using PHP, update the 'api/config.php' file with your API key:
-
-            $OPENAI_API_KEY = 'YOUR_API_KEY';
-
-    3. Initialization
+            OPENAI_API_KEY=YOUR_API_KEY
 
-            const builder = new ContentBox({
-                    sendCommandUrl: '/sendcommand',
-            });
+       Alternatively, if you're using PHP, update the api/config.php file with your API key:
 
-       If you're using PHP:
-
-            const builder = new ContentBox({
-                    sendCommandUrl: '/sendcommand',
-            });
+            $OPENAI_API_KEY = 'YOUR_API_KEY';
 
 - For speech recognition (if 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 example project.
-    Obtain the Deepgram API key and update the .env file with your API key.
+    Obtain the Deepgram API key from https://deepgram.com and update the .env file with your API key.
     Then enable the 'speechTranscribeUrl' parameter in the ContentBox initialization (src/index.js).
 
 - To use the AI image generation:
     1. Obtain the API key from https://getimg.ai/tools/api.
     2. Update the .env file with your API key.
 
+            GETIMG_API_KEY=YOUR_API_KEY
+
        Alternatively, if you're using PHP, update the 'api/config.php' file with your API key:
 
             $GETIMG_API_KEY = 'YOUR_API_KEY';
 
-    3. Initialization
+- To try the examples using S3 Storage:
+
+    A. HTML example
+
+        1. Update the .env file with your S3 storage credentials.
+
+            AWS_KEY=YOUR_KEY
+            AWS_SECRET=YOUR_SECRET
+            AWS_BUCKET=BUCKET_NAME
+            AWS_URL=http://BUCKET_NAME.s3-website-us-east-1.amazonaws.com 
+            AWS_REGION=us-east-1
+
+        2. Install the server dependencies:
+
+            > npm install
+
+        3. Run the server:
 
-            const builder = new ContentBox({
-                textToImageUrl: '/texttoimage', 
-                upscaleImageUrl: '/upscaleimage',
-                imageAutoUpscale: true,
-            });
-    
-       If you're using PHP:
+            > node server-aws.js
 
-            const builder = new ContentBox({
-                textToImageUrl: 'api/texttoimage.php', 
-                upscaleImageUrl: 'api/upscaleimage.php',
-                imageAutoUpscale: true,
-            });
+        4. Open from your browser:
 
-- Please add your own security to the API endpoints (public/api/)!
+            http://localhost:8081/example-s3.html 
 
-- You can try a full working example by running the example project (please refer to the previous instructions).
+    B. PHP example
 
+        1. Update the public/api/config.php with your S3 storage credentials.
 
-______________________
-SOURCE CODE PACKAGE
+            $AWS_KEY = 'YOUR_KEY';
+            $AWS_SECRET = 'YOUR_SECRET';
+            $AWS_BUCKET = 'BUCKET_NAME';
+            $AWS_URL = 'http://BUCKET_NAME.s3-website-us-east-1.amazonaws.com';
+            $AWS_REGION = 'us-east-1';
 
-If you have the ContentBox source code:
+        2. Download the AWS SDK for PHP phar file (aws.phar) from https://github.com/aws/aws-sdk-php/releases 
+           and copy it to your project's public/api/ directory.
 
-- 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.
+        3. Open from your browser:
 
-- When finished, to build the JavaScript code for production use, update the package.json file:
+            http://localhost/.../public/example-s3.php
 
-    {
-    "name": "@innovastudio/contentbox",
-    "type": "module",
 
-    }
+- IMPORTANT: 
 
-  Then, run:
+    Please add your own security to the API endpoints (public/api/)!
 
-    > npm run build
 
-  The minified JS will be generated in the folder: 'public/contentbuilder/contentbuilder.min.js'.
-  You can test it by opening: 'public/example.html'.
-  If you're using Visual Studio Code, right-click on the 'example.html' file and select "Open with Live Server".
+- If you have Source Code package (Super license), please refer to:
 
-- To build CSS from SCSS files, run:
+    readme-sourcecode.txt
 
-    > npm run scss
+    for additional information.
 
 
 _____________________________________________