Skip to content

Commit c778477

Browse files
code-boxxcode-boxx
committed
12 Feb 2024
1) Added YouTube quickstart video to installer and about page. 2) Screenshots update.
1 parent 87327e4 commit c778477

File tree

10 files changed

+135
-65
lines changed

10 files changed

+135
-65
lines changed

‎README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,18 +35,18 @@ Storage Boxx is an open-source PHP Inventory Management System. With a built-in
3535
## :floppy_disk: INSTALLATION
3636
1) Manually download or git clone into your `http` folder.
3737
2) Access `http://your-site.com/` in your browser and walk through the installer.
38-
3) If you want, add the [optional AI Assistant](https://github.com/code-boxx/Storage-Boxx-AI) after the installation.
38+
3) Check out [Storage Boxx Quickstart Guide on YouTube](https://www.youtube.com/watch?v=T-4FxpHE5xU)
3939
<br><br>
4040

4141
## :star: SUPPORT
4242
1) Just give this project a star. That will indirectly drive more traffic a little bit. :wink:
4343
2) [Sponsor this project](https://github.com/sponsors/code-boxx). Even a small one time amount helps.
4444
<br><br>
4545

46-
## :bulb: DOCUMENTATION
47-
1) [How To Use](https://code-boxx.com/storage-boxx-php-inventory-system/#sec-use)
48-
2) [FAQ](https://code-boxx.com/core-boxx-php-framework/#sec-faq)
49-
3) [For The Developers](https://code-boxx.com/storage-boxx-php-inventory-system/#sec-dev)
46+
## :bulb: DOCUMENTATION + EXTRAS
47+
1) [FAQ](https://code-boxx.com/core-boxx-php-framework/#sec-faq)
48+
2) [For The Developers](https://code-boxx.com/storage-boxx-php-inventory-system/#sec-dev)
49+
3) If you want, add the [optional AI Assistant](https://github.com/code-boxx/Storage-Boxx-AI) after the installation.
5050
<br><br>
5151

5252
## :electric_plug: CREDITS AND FRAMEWORKS USED

‎TODO.txt‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
STORAGE BOXX TO DO / WISH LIST
22
==============================
33

4-
* Check Item update, add More Info
5-
* Suppliers
6-
* Purchases + Projected In/Out
7-
* Items list update
8-
* Remove Suppliers from dropdown options
4+
* Check Item page update, add more info.
5+
* Suppliers > Purchase
6+
* Projected In/Out
7+
* Items list update.
8+
* Remove "suppliers" from dropdown options
99
* Rename "movement" to "check" (replace suppliers with check)
1010
* Links
1111
* Suppliers > PO
1212
* Customers > DO
13-
* Items > Suppliers > Purchase
14-
* Auto-create PO for all items low on stock
15-
* Home page widgets
16-
* Directly email PO/DO
17-
* More reports - delivery/sales, purchases.
13+
* Auto-create PO for all items low on stock.
14+
* Home page widgets.
15+
* Directly email PO/DO.
16+
* More reports - delivery, purchases, charts, projections.
1817
* Print QR/NFC after import items.
18+
* Mass print QR code for items.
1919
* Customer "address book"? Different branches/departments - For DO.
20-
* Add tutorial videos.
20+
* Partial delivery/receive?

‎assets/storage-boxx-2.png‎

6.43 KB
Loading

‎assets/storage-boxx-3.png‎

-2.84 KB
Loading

‎assets/storage-boxx-4.png‎

-456 Bytes
Loading

‎assets/storage-boxx-5.png‎

841 Bytes
Loading

‎assets/tsparticles.confetti.bundle.min.js‎

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎lib/CORE-Install-HTML.php‎

Lines changed: 76 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
}
1818
}
1919

20-
// (C) HTML ?>
20+
// (C) INSTALLATION PAGE HTML ?>
2121
<!DOCTYPE html>
2222
<html>
2323
<head>
@@ -26,30 +26,31 @@
2626
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.5">
2727
<meta name="robots" content="noindex">
2828
<link rel="stylesheet" href="<?=HOST_ASSETS?>bootstrap.min.css">
29+
<link rel="stylesheet" href="<?=HOST_ASSETS?>PAGE-cb.css">
30+
<script defer src="<?=HOST_ASSETS?>tsparticles.confetti.bundle.min.js"></script>
2931
<script defer src="<?=HOST_ASSETS?>bootstrap.bundle.min.js"></script>
3032
<?php require PATH_LIB . "CORE-Install-JS.php"; ?>
3133
</head>
3234
<body><div class="container p-4">
33-
<?php if (I_APACHE === false || I_REWRITE === false) { ?>
34-
<!-- (C1) WARNINGS -->
35-
<div class="bg-danger text-white p-2 mb-2">
36-
If you are running Apache Web Server - Please enable <code class="text-white">MOD_REWRITE</code>.
37-
</div>
38-
<div class="bg-danger text-white p-2">
39-
If you are not running Apache Web Server, you can still try to proceed.
40-
After the installation, "translate" your own <code class="text-white">.htaccess</code> file.
41-
</div>
42-
<?php } ?>
35+
<form id="iForm" onsubmit="return false">
36+
<?php if (I_APACHE === false || I_REWRITE === false) { ?>
37+
<!-- (C1) WARNINGS -->
38+
<div class="bg-danger text-white p-2 mb-2">
39+
If you are running Apache Web Server - Please enable <code class="text-white">MOD_REWRITE</code>.
40+
</div>
41+
<div class="bg-danger text-white p-2">
42+
If you are not running Apache Web Server, you can still try to proceed.
43+
After the installation, "translate" your own <code class="text-white">.htaccess</code> file.
44+
</div>
45+
<?php } ?>
4346

44-
<!-- (C2) HEADER -->
45-
<div class="d-flex align-items-center mb-3">
46-
<img src="assets/favicon.png" class="me-2">
47-
<h1><?=strtoupper(SITE_NAME)?> INSTALLATION</h1>
48-
</div>
47+
<!-- (C2) HEADER -->
48+
<div class="d-flex align-items-center mb-3">
49+
<img src="assets/favicon.png" class="me-2">
50+
<h1><?=strtoupper(SITE_NAME)?> INSTALLATION</h1>
51+
</div>
4952

50-
<!-- (C3) INSTALLATION FORM -->
51-
<form id="iForm" onsubmit="return false">
52-
<!-- (C3-1) HOST URL -->
53+
<!-- (C3) HOST URL -->
5354
<h4 class="text-danger mb-3">HOST URL</h4>
5455
<div class="bg-light border p-3 mb-3">
5556
<div class="form-floating mb-2">
@@ -70,7 +71,7 @@
7071
</div>
7172
</div>
7273

73-
<!-- (C3-2) API ENDPOINT -->
74+
<!-- (C4) API ENDPOINT -->
7475
<h4 class="text-danger mb-3">API ENDPOINT</h4>
7576
<div class="bg-light border p-3 mb-3">
7677
<div class="form-floating mb-2">
@@ -110,7 +111,7 @@
110111
</div>
111112
</div>
112113

113-
<!-- (C3-3) DATABASE -->
114+
<!-- (C5) DATABASE -->
114115
<h4 class="text-danger mb-3">DATABASE</h4>
115116
<div class="bg-light border p-3 mb-3">
116117
<div class="form-floating mb-2">
@@ -134,7 +135,7 @@
134135
</div>
135136
</div>
136137

137-
<!-- (C3-4) EMAIL & TIMEZONE -->
138+
<!-- (C6) EMAIL & TIMEZONE -->
138139
<h4 class="text-danger mb-3">SYSTEM DEFAULTS</h4>
139140
<div class="bg-light border p-3 mb-3">
140141
<div class="form-floating mb-2">
@@ -151,7 +152,7 @@
151152
</div>
152153
</div>
153154

154-
<!-- (C3-5) COMPANY -->
155+
<!-- (C7) COMPANY -->
155156
<?php if (I_CO) { ?>
156157
<h4 class="text-danger mb-3">COMPANY</h4>
157158
<div class="bg-light border p-3 mb-3">
@@ -177,7 +178,7 @@
177178
</div>
178179
<?php } ?>
179180

180-
<!-- (C3-6) ADMIN USER -->
181+
<!-- (C8) ADMIN USER -->
181182
<?php if (I_USER) { ?>
182183
<h4 class="text-danger mb-3">ADMIN USER</h4>
183184
<div class="bg-light border p-3 mb-3">
@@ -204,7 +205,7 @@
204205
</div>
205206
<?php } ?>
206207

207-
<!-- (C3-7) JWT -->
208+
<!-- (C9) JWT -->
208209
<h4 class="text-danger mb-3">JSON WEB TOKEN</h4>
209210
<div class="bg-light border p-3 mb-3">
210211
<div class="form-floating mb-2">
@@ -224,7 +225,7 @@
224225
</div>
225226
</div>
226227

227-
<!-- (C3-8) PUSH NOTIFICATION -->
228+
<!-- (C10) PUSH NOTIFICATION -->
228229
<?php if (I_PUSH) { ?>
229230
<h4 class="text-danger mb-3">WEB PUSH VAPID KEYS</h4>
230231
<div class="bg-light border p-3 mb-3">
@@ -245,8 +246,56 @@
245246
</div>
246247
<?php } ?>
247248

248-
<!-- (C3-9) GO! -->
249+
<!-- (C11) GO! -->
249250
<input id="gobtn" type="submit" class="btn btn-primary" value="Go!" disabled>
250251
</form>
252+
253+
<!-- (C12) DONE -->
254+
<!-- @TODO - UPDATE LINKS FOR YOUR PROJECT -->
255+
<div id="iCelebrate" class="d-none">
256+
<h1 class="my-4">INSTALLATION COMPLETE</h1>
257+
258+
<h4 class="text-danger mb-3">QUICKSTART</h4>
259+
<div class="bg-light border p-3 mb-3">
260+
<iframe width="560" height="315" src="https://www.youtube.com/embed/T-4FxpHE5xU?si=e6R2Cx_o6JFdOP3F" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
261+
</div>
262+
263+
<h4 class="text-danger m-0">A FEW LINKS</h4>
264+
<div class="text-secondary mb-3"><small>
265+
* These links can be accessed in the "Help/About" section of the admin panel.
266+
</small></div>
267+
<div class="bg-light border p-3 mb-3"><ul class="list-group">
268+
<li class="list-group-item d-flex align-items-center">
269+
<a class="btn btn-danger" href="https://code-boxx.com/storage-boxx-php-inventory-system/" target="_blank">
270+
<i class="ico-sm icon-home3"></i> Official
271+
</a>
272+
<div class="ms-2">Official Storage Boxx Page (Documentation &amp; Stuff).</div>
273+
</li>
274+
<li class="list-group-item d-flex align-items-center">
275+
<a class="btn btn-danger" href="https://github.com/code-boxx/Storage-Boxx-PHP-Inventory-System/issues/new/choose" target="_blank">
276+
<i class="ico-sm icon-bug"></i> Report
277+
</a>
278+
<div class="ms-2">Report a bug / Feature Request.</div>
279+
</li>
280+
<li class="list-group-item d-flex align-items-center">
281+
<a class="btn btn-danger" href="https://github.com/code-boxx/Storage-Boxx-PHP-Inventory-System" target="_blank">
282+
<i class="ico-sm icon-star-full"></i> Star
283+
</a>
284+
<div class="ms-2">Just give a star to Storage Boxx on GitHub - It's free.</div>
285+
</li>
286+
<li class="list-group-item d-flex align-items-center">
287+
<a class="btn btn-danger" href="https://github.com/sponsors/code-boxx?frequency=one-time" target="_blank">
288+
<i class="ico-sm icon-heart"></i> Donate
289+
</a>
290+
<div class="ms-2">Buy a malnourished developer some food. Even a small one-time amount helps.</div>
291+
</li>
292+
<li class="list-group-item d-flex align-items-center">
293+
<a class="btn btn-danger" id="iDone">
294+
<i class="ico-sm icon-checkmark"></i> Done
295+
</a>
296+
<div class="ms-2">To the home page.</div>
297+
</li>
298+
</ul></div>
299+
</div>
251300
</div></body>
252301
</html>

‎lib/CORE-Install-JS.php‎

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -113,17 +113,26 @@
113113
// (E8) VERIFY HTACCESS
114114
install.ajax(url + "installer/test/", "E2", () => {
115115
// (E9) PROCEED INSTALLATION
116-
install.ajax(url, "F", () => {
117-
alert("Installation complete, this page will now reload.");
118-
location.href = url;
119-
});
116+
install.ajax(url, "F", () => install.celebrate(url));
120117
});
121118
});
122119
return false;
120+
},
121+
122+
// (F) INSTALLATION COMPLETE - CELEBRATE!
123+
celebrate : url => {
124+
document.getElementById("iForm").innerHTML = "";
125+
document.getElementById("iDone").href = url;
126+
document.getElementById("iCelebrate").classList.remove("d-none");
127+
confetti({
128+
particleCount: 100,
129+
spread: 70,
130+
origin: { y: 0.6 },
131+
});
123132
}
124133
};
125134

126-
// (F) GENERATE RANDOM JWT KEY + ENABLE INSTALL FORM ON WINDOW LOAD
135+
// (G) GENERATE RANDOM JWT KEY + ENABLE INSTALL FORM ON WINDOW LOAD
127136
window.onload = () => {
128137
install.rnd();
129138
install.toggle(true);

‎pages/PAGE-about.php‎

Lines changed: 27 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,7 @@
88
<i class="ico-sm icon-question"></i> HOW TO USE
99
</h5>
1010
<div class="bg-white border p-4 mb-4">
11-
<a href="https://code-boxx.com/storage-boxx-php-inventory-system/#sec-use" target="_blank">
12-
Quick Tutorial
13-
</a>
11+
<iframe width="560" height="315" src="https://www.youtube.com/embed/T-4FxpHE5xU?si=e6R2Cx_o6JFdOP3F" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
1412
</div>
1513

1614
<h5 class="text-danger mb-0">
@@ -19,17 +17,32 @@
1917
<div class="text-secondary mb-2"><small>
2018
* Help keep Storage Boxx alive, even if it is just a little bit.
2119
</small></div>
22-
<div class="bg-white border p-4 mb-4">
23-
<a class="my-1 btn btn-danger d-flex-inline" href="https://www.paypal.com/paypalme/wstoh/5" target="_blank">
24-
<i class="ico-sm icon-mug"></i> Buy me a coffee
25-
</a>
26-
<a class="my-1 btn btn-danger d-flex-inline" href="https://github.com/sponsors/code-boxx" target="_blank">
27-
<i class="ico-sm icon-heart"></i> GitHub Sponsor
28-
</a>
29-
<a class="my-1 btn btn-danger d-flex-inline" href="https://payhip.com/codeboxx" target="_blank">
30-
<i class="ico-sm icon-cart"></i> Code Boxx Store
31-
</a>
32-
</div>
20+
<div class="bg-white border p-4 mb-4"><ul class="list-group">
21+
<li class="list-group-item d-flex align-items-center">
22+
<a class="btn btn-danger" href="https://github.com/code-boxx/Storage-Boxx-PHP-Inventory-System" target="_blank">
23+
<i class="ico-sm icon-star-full"></i> Star
24+
</a>
25+
<div class="ms-2">Just give a star to Storage Boxx on GitHub - It's free.</div>
26+
</li>
27+
<li class="list-group-item d-flex align-items-center">
28+
<a class="btn btn-danger" href="https://www.paypal.com/paypalme/wstoh/5" target="_blank">
29+
<i class="ico-sm icon-mug"></i> Coffee
30+
</a>
31+
<div class="ms-2">Buy me a coffee.</div>
32+
</li>
33+
<li class="list-group-item d-flex align-items-center">
34+
<a class="btn btn-danger" href="https://github.com/sponsors/code-boxx?frequency=one-time" target="_blank">
35+
<i class="ico-sm icon-heart"></i> Donate
36+
</a>
37+
<div class="ms-2">Buy a malnourished developer some food. Even a small one-time amount helps.</div>
38+
</li>
39+
<li class="list-group-item d-flex align-items-center">
40+
<a class="btn btn-danger" href="https://payhip.com/codeboxx" target="_blank">
41+
<i class="ico-sm icon-cart"></i> Shop
42+
</a>
43+
<div class="ms-2">Buy an eBook from the Code Boxx Store.</div>
44+
</li>
45+
</ul></div>
3346

3447
<h5 class="text-danger mb-0">
3548
<i class="ico-sm icon-power-cord"></i> RECOMMENDED EQUIPMENT
@@ -78,9 +91,6 @@
7891
<li><a href="https://code-boxx.com/storage-boxx-php-inventory-system/#sec-dev" target="_blank">
7992
Developer Notes
8093
</a></li>
81-
<li><a href="https://github.com/code-boxx/Storage-Boxx-PHP-Inventory-System" target="_blank">
82-
Storage Boxx GitHub
83-
</a></li>
8494
<li><a href="https://github.com/code-boxx/Storage-Boxx-PHP-Inventory-System/issues/new/choose" target="_blank">
8595
Report a bug / Feature Request
8696
</a></li>

0 commit comments

Comments
 (0)