Storage Boxx – PHP Inventory System (Free Open Source)

Storage Boxx is a simple, free, and open-source PHP Inventory Management System. This is not the “super professional crazy bloated with a lot of features” kind of system. But it does cover the basics and has a built-in HTML webcam QR code scanner. This should help the small businesses get started with their inventory stock keeping.

 

TABLE OF CONTENTS

Download & Notes	How To Use	Quick Reference
How To Develop	Common Problems

 

 

 

REQUIREMENTS

• Apache Mod Rewrite
• PHP MYSQL PDO Extension
• Best to have at least PHP 7.4
• “Grade A” browser

Storage Boxx has not been extensively tested, but it is developed and works on a WAMP8 (Windows Apache MySQL PHP 8) server.

 

INSTALLATION

Just access index.php in your browser and walk through the installer.

 

 

LICENSE & DOWNLOAD

Storage Boxx is released under the MIT License. You are free to use it for your own personal and commercial projects, modify it as you see fit. On the condition that there the software is provided “as-is”. There are no warranties provided and “no strings attached”. Code Boxx and the authors are not liable for any claims, damages, or liabilities.

Download Storage Boxx | GitHub | SourceForge

 

 

STEP 1) REGISTER INVENTORY ITEMS

• Go to the “Manage Inventory” section.
• Click on “Add”.
• Register the item.
• Print out the QR code if you want – It does speed things up and makes things easier to manage. Get yourself a USB barcode scanner if you do not already have one. A simple one only costs like… 30 bucks these days.
• Rinse and repeat, register all your items (or do some mass import from CSV magic into the database on your own).

 

STEP 2) UPDATE STOCK LEVELS

• Next, go to the “Stock Movement” section.
• This should be self-explanatory. Fill in and update the stock levels whenever required.

 

 

STEP 3) CHECKING STOCK LEVELS

To check the stock levels, simply type in the SKU or scan the QR code.

 

 

FOLDER STRUCTURE

• api/ The API endpoint.
• assets/ Public images, Javascript, CSS, etc…
• lib/ Core engine and library files.
• pages/ HTML pages.

Yes, there are only 4 folders in the entire system.

 

 

THE DATABASE

Field	Description
stock_sku	The SKU of the item, primary key.
stock_name	Name of the item.
stock_desc	Description of the item.
stock_unit	Unit of measurement.
stock_qty	Current quantity in stock.

Field	Description
stock_sku	The SKU of the item. Primary key.
mvt_date	Date of movement entry. Primary key.
mvt_direction	The direction of the movement. I – Stock In (receive) O – Stock Out (release) T – Stock Take (audit)
user_id	The user who made this movement entry.
mvt_qty	Quantity moved.
mvt_notes	Notes, if any.

Field	Description
user_id	The user ID, primary key.
user_name	The user name.
user_email	The user’s email address.
user_password	The password. Encrypted.

 

 

THE FRAMEWORKS & CREDITS

Storage Boxx is built using:

• Bootstrap
• QR Code Scanner
• QR Code Generator
• Core Boxx. Believe it or not, the initial version is built within 48 man-hours using:
  • Core Boxx Users Module
  • Modified Core Boxx Pretty URL Module

Go ahead and check those out if you want… The other “pre-developed” modules of Core Boxx should also snap right in.

 

 

STEP 1) CREATE/MODIFY DATABASE TABLES

Add your new tables or views, modify the existing ones.

 

STEP 2) ADD/UPDATE SYSTEM MODULE

class Report extends Core {
  function getMoveByUser ($id) {
    return $this->DB->fetchAll(
      "SELECT * FROM `stock_mvt` WHERE `user_id`=? ORDER BY `mvt_date` DESC",
      [$id]
    );
  }
}

To add a new module, create lib/LIB-Module.php. Define class Module extends Core, and add functions inside. In this example, we add a new report module – lib/LIB-Report.php and class Report extends Core.

That’s all. This new module can now be loaded via $_CORE->load("Report") and the function can be accessed via $_CORE->Report->getMoveByUser().

 

STEP 3) ADD/UPDATE API ENDPOINT (OPTIONAL)

// (A) REGISTERED USERS ONLY
if (!isset($_SESS["user"])) {
  $_CORE->respond(0, "Please sign in first", null, null, 403);
}
 
switch ($_REQ) {
  // (B) INVALID REQUEST
  default:
    $_CORE->respond(0, "Invalid request", null, null, 400);
    break;
 
  // (C) MOVE BY USER REPORT
  case "getMoveByUser":
    $_CORE->autoGETAPI("Report", "getMoveByUser");
    break;
}

Create api/API-Module.php. For this example, send $_POST["id"]=123 to http://site.com/Report/getMoveByUser/ to get the movement report – The API will reply with a JSON encoded string.

 

STEP 4) ADD/UPDATE HTML CSS JAVASCRIPT

• Add your new pages in pages/.
  • For example, pages/PAGE-report.php can be accessed from http://site.com/report.
  • Take note – PAGE-report.php can only be accessed by users who are signed in.

That’s about it. Just reverse engineer and copy from the existing libraries, API, and pages… You will see the development pattern here.

 

 

 

I FORGOT THE PASSWORD OR DELETED ALL ADMIN ACCOUNTS

require "lib/CORE-go.php";
$_CORE->load("Users");
$_CORE->Users->save("NAME", "EMAIL", "PASSWORD", OPTIONAL-USER-ID);

Just create an “account recovery” script to create a new account (or update an existing one). Run and delete this afterward.

 

MIGRATING TO A NEW DOMAIN OR CHANGING THE URL PATH

• Simply update HOST_BASE in lib/CORE-config.php.
• Run $_CORE->Route->init() to update the .htaccess and api/.htaccess files.
• Clear the browser cache to prevent irritating cache redirects.

 

UPGRADING

• If your existing copy has an options table – Just override all the files and access index.php. The installer will take care of database updates (if any).
• If not – Manually import the options table from SQL-storage-boxx.sql, create a STOREBOXX_VER entry with a value of 0 and group 0. Thereafter, just copy the new files and let the installer do the magic.

 

MANUAL INSTALLATION

• Create a database and import lib/SQL-storage-boxx.sql.
• Open lib/CORE-config.php, update the settings to your own.
  • The host settings.
  • Database settings.
  • If you want to develop mobile apps, consider enabling CORS.
  • Generate your own JWT secret key, set the issuer to your domain or company name.
• Run $_CORE->Route->init() to generate the .htaccess and api/.htaccess files.
• Create your own admin user, see “forgot password” above.
• Rename lib/INSTALL-index.foo to index.php.

 

NOT WORKING. DON’T KNOW WHY.

Open the developer’s console, reload the page and see the error message.

How To Debug Javascript – A Very Simple Guide

How to Debug PHP Code – A Very Simple Guide