13 Dec 2023

1) Bootstrap update.
2) JWT library update.
3) Some cosmetic updates.

Author: code-boxx

README.md

@@ -1,7 +1,36 @@
 ## CORE BOXX
 Core Boxx is a PHP framework built with the concept of simplicity and modularity. Install and load only what you need, not bloated with unused features.
+<br><br>
 
-TLDR - "Jumpstart your project with a collection of predefined plug-and-play modules".
+## :ballot_box_with_check: REQUIREMENTS
+1) LAMP/WAMP/MAMP/XAMPP
+2) Apache Mod Rewrite
+3) PHP MYSQL PDO Extension
+4) At least PHP 8.0
+<br><br>
+
+## :floppy_disk: INSTALLATION & NOTES
+- Copy the contents of `core/` into your HTTP folder.
+- Access `http://your-site.com/` in the browser and walk through the installer.
+
+## :zap: OPTIONAL MODULES
+- The rest of the folders are optional modules.
+- To install the optional modules, check out their respective `README.md` files.
+<br><br>
+
+## :star: SUPPORT
+Like this project? Just give it a star. That will indirectly help grow my blog a little bit. :wink:
+<br><br>
+
+## :camera: SCREENSHOTS
+<p float="left">
+  <img width="250" src="https://github.com/code-boxx/Core-Boxx-PHP-Framework/blob/main/core/assets/core-boxx-1.png">
+  <img width="250" src="https://github.com/code-boxx/Core-Boxx-PHP-Framework/blob/main/core/assets/core-boxx-2.png">
+  <img width="250" src="https://github.com/code-boxx/Core-Boxx-PHP-Framework/blob/main/core/assets/core-boxx-3.png">
+  <img width="250" src="https://github.com/code-boxx/Core-Boxx-PHP-Framework/blob/main/core/assets/core-boxx-4.png">
+  <img width="250" src="https://github.com/code-boxx/Core-Boxx-PHP-Framework/blob/main/core/assets/core-boxx-5.png">
+  <img width="250" src="https://github.com/code-boxx/Core-Boxx-PHP-Framework/blob/main/core/assets/core-boxx-6.png">
+</p>
 <br><br>
 
 ## :white_check_mark: "OUT OF THE BOX" FEATURES
@@ -12,7 +41,7 @@ TLDR - "Jumpstart your project with a collection of predefined plug-and-play mod
 5) Bootstrap HTML template.
 <br><br>
 
-## :electric_plug: PLENTY OF MODULES
+## :electric_plug: MODULES
 * `admin` Admin panel.
 * `ai chatbot` Run a local AI Chatbot (Python).
 * `autocomplete` Autocomplete/suggestion.
@@ -30,40 +59,12 @@ TLDR - "Jumpstart your project with a collection of predefined plug-and-play mod
 * `web push` Send push notifications.
 <br><br>
 
-## :camera: SCREENSHOTS
-<p float="left">
-  <img width="250" src="https://github.com/code-boxx/Core-Boxx-PHP-Framework/blob/main/core/assets/core-boxx-1.png">
-  <img width="250" src="https://github.com/code-boxx/Core-Boxx-PHP-Framework/blob/main/core/assets/core-boxx-2.png">
-  <img width="250" src="https://github.com/code-boxx/Core-Boxx-PHP-Framework/blob/main/core/assets/core-boxx-3.png">
-  <img width="250" src="https://github.com/code-boxx/Core-Boxx-PHP-Framework/blob/main/core/assets/core-boxx-4.png">
-  <img width="250" src="https://github.com/code-boxx/Core-Boxx-PHP-Framework/blob/main/core/assets/core-boxx-5.png">
-  <img width="250" src="https://github.com/code-boxx/Core-Boxx-PHP-Framework/blob/main/core/assets/core-boxx-6.png">
-</p>
-<br><br>
-
-## :ballot_box_with_check: REQUIREMENTS
-1) LAMP/WAMP/MAMP/XAMPP
-2) Apache Mod Rewrite
-3) PHP MYSQL PDO Extension
-4) At least PHP 8.0
-<br><br>
-
-## :floppy_disk: INSTALLATION & NOTES
-1) Just copy `core/` into your project folder. Access `http://your-site.com/` in the browser and walk through the installer.
-2) The rest are optional modules... Too lazy and messy to create separate repos for each.
-3) Some modules may require "extra installation steps", do check out the respective documentation - https://code-boxx.com/core-boxx-php-framework/#sec-ref
-<br><br>
-
-## :bulb: DOCUMENTATION & FRAMEWORKS
+## :bulb: DOCUMENTATION & CREDITS
 1) Visit [Core Boxx](https://code-boxx.com/core-boxx-php-framework/) for more for the full documentation!
 2) Built on [Bootstrap](https://getbootstrap.com/) and [IcoMoon](https://icomoon.io/).
 3) Using [PHP-JWT library](https://github.com/firebase/php-jwt)
 <br><br>
 
-## :star: SUPPORT
-Like this project? Just give it a star. That will indirectly help grow my blog a little bit. :wink:
-<br><br>
-
 ## :newspaper: LICENSE
 Copyright by Code Boxx
 
@@ -83,4 +84,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

admin/README.md

@@ -6,7 +6,7 @@ https://code-boxx.com/core-boxx-admin-panel/
 * [Users Module](https://github.com/code-boxx/Core-Boxx-PHP-Framework/tree/main/users)
 
 ## INSTALL
-* Copy/unzip this module into your existing Core Boxx project folder.
+* Copy this module into your existing Core Boxx project folder.
 * Access `http://your-site.com/install/admin`, this will automatically:
   - Create a new `HOST_ADMIN` definition in `lib/CORE-config.php`.
   - Add a new `$wild = [ "admin/" => "ADM-check.php" ]` line to `lib/HOOK-Routes.php`.
@@ -33,4 +33,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

ai chatbot/README.md

@@ -9,19 +9,19 @@ https://code-boxx.com/core-boxx-ai-chatbot/
 * [Nvidia CUDA Toolkit](https://developer.nvidia.com/cuda-toolkit) - If you have an Nvidia graphics card.
 
 ## RECOMMENDED
-* An Nvidia graphics card with at least 8GB VRAM is highly recommended.
+* An Nvidia graphics card with at least 8GB VRAM.
 * You can TRY to run on CPU-only, but it is painfully slow.
 
 ## INSTALLATION
-* Copy/unzip this module into your existing Core Boxx project folder.
+* Copy this module into your existing Core Boxx project folder.
 * Put documents you want the AI to "learn" into `chatbot/docs`, accepted file types - `csv pdf txt epub html md odt doc docx ppt pptx`.
 * Start install - *BE WARNED, SEVERAL GIGABYTES WORTH OF DOWNLOAD!*
   * GPU - Run `0-setup.bat` (Windows) `0-setup.sh` (Linux).
   * CPU - Run `0-setup.bat CPU` (Windows) `0-setup.sh CPU` (Linux). 
 * You will need to [choose and download an AI model](https://code-boxx.com/core-boxx-ai-chatbot/#sec-choose).
 * Run `2-bot.bat 2-bot.sh`, access `http://your-site.com/ai/` for the demo.
 
-## REBUILD THE DATEBASE
+## TO REBUILD THE DATEBASE
 * Simply add/remove documents from `chatbot/docs`.
 * Run `1-create.bat / 1-create.sh`.
 

ai chatbot/assets/ai-bot.webp

@@ -1,7 +1,7 @@
 # (A) LOAD SETTINGS & MODULES
 import a_settings as set
 import c_oto_rodo as oto
-from langchain import PromptTemplate
+from langchain.prompts import PromptTemplate
 from langchain.vectorstores import Chroma
 from langchain.embeddings import HuggingFaceInstructEmbeddings
 from langchain.chains import RetrievalQA

ai chatbot/assets/ai-human.webp

@@ -5,7 +5,7 @@ https://code-boxx.com/core-boxx-autocomplete-module/
 * [Core Boxx](https://github.com/code-boxx/Core-Boxx-PHP-Framework/tree/main/core)
 
 ## INSTALL
-* Copy/unzip this module into your existing Core Boxx project folder.
+* Copy this module into your existing Core Boxx project folder.
 * Access `http://your-site.com/install/autocomplete`, this will automatically:
   - Add a new `SUGGEST_LIMIT` setting in the database.
   - Delete `PAGE-install-autocomplete.php` itself.
@@ -33,4 +33,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

ai chatbot/assets/ai-system.webp

@@ -5,7 +5,7 @@ https://code-boxx.com/core-boxx-calendar-module/
 * [Core Boxx](https://github.com/code-boxx/Core-Boxx-PHP-Framework/tree/main/core)
 
 ## INSTALL
-* Copy/unzip this module into your existing Core Boxx project folder.
+* Copy this module into your existing Core Boxx project folder.
 * Access `http://your-site.com/install/calendar`, this will automatically:
   - Import `lib/SQL-Calendar.sql` into your database.
   - Delete `PAGE-install-calendar.php` itself.
@@ -31,4 +31,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

ai chatbot/chatbot/d_bot.py

@@ -6,7 +6,7 @@ https://code-boxx.com/core-boxx-comments-module/
 * [Users Module](https://github.com/code-boxx/Core-Boxx-PHP-Framework/tree/main/users)
 
 ## INSTALL
-* Copy/unzip this module into your existing Core Boxx project folder.
+* Copy this module into your existing Core Boxx project folder.
 * Acces `http://your-site.com/install/comments`, this will automatically:
   - Import `lib/SQL-Comments.sql` into your database.
   - Delete `PAGE-install-comments.php` itself.
@@ -36,4 +36,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.