Neatened up :D

.gitignore

@@ -0,0 +1,69 @@
+# Uncomment these types if you want even more clean repository. But be careful.
+# It can make harm to an existing project source. Read explanations below.
+#
+# Resource files are binaries containing manifest, project icon and version info.
+# They can not be viewed as text or compared by diff-tools. Consider replacing them with .rc files.
+#*.res
+#
+# Type library file (binary). In old Delphi versions it should be stored.
+# Since Delphi 2009 it is produced from .ridl file and can safely be ignored.
+#*.tlb
+#
+# Diagram Portfolio file. Used by the diagram editor up to Delphi 7.
+# Uncomment this if you are not using diagrams or use newer Delphi version.
+#*.ddp
+#
+# Visual LiveBindings file. Added in Delphi XE2.
+# Uncomment this if you are not using LiveBindings Designer.
+#*.vlb
+#
+# Deployment Manager configuration file for your project. Added in Delphi XE2.
+# Uncomment this if it is not mobile development and you do not use remote debug feature.
+#*.deployproj
+#
+# C++ object files produced when C/C++ Output file generation is configured.
+# Uncomment this if you are not using external objects (zlib library for example).
+#*.obj
+#
+
+# Delphi compiler-generated binaries (safe to delete)
+*.exe
+*.dll
+*.bpl
+*.bpi
+*.dcp
+*.so
+*.apk
+*.drc
+*.map
+*.dres
+*.rsm
+*.tds
+*.dcu
+*.lib
+*.a
+*.o
+*.ocx
+
+# Delphi autogenerated files (duplicated info)
+*.cfg
+*.hpp
+*Resource.rc
+
+# Delphi local files (user-specific info)
+*.local
+*.identcache
+*.projdata
+*.tvsconfig
+*.dsk
+
+# Delphi history and backups
+__history/
+__recovery/
+*.~*
+
+# Castalia statistics file (since XE7 Castalia is distributed with Delphi)
+*.stat
+
+# Boss dependency manager vendor folder https://github.com/HashLoad/boss
+modules/

Assets/About.txt

@@ -0,0 +1,19 @@
+Developed with the invaluable support of:
+
+- Gustavo Carreno: Application Tester & Motivator
+- KodeZwerg: Application Tester & Red editbox inspiration
+- Alecu Stefan: Application Tester & Erroneous/ Extreme Data Validation Tester, helped aid understanding of 'in' operator
+- Keshan Pillay: Verified that procedures were used efficiently and correctly
+- Glen Surtees: Error checking, taught me how to use Val()
+- Thomas Jourdan: Error checking & code recommendations & improvements, ShowHint, OnKeyPress 
+- Jan Andreasan: Error checking & code recommendations & improvements, inspired uniform NavPanel
+- Mr. Long: Procedures (https://www.youtube.com/watch?v=NHLLxafoVxM)
+- DelphiBasics: InputQuery (https://www.delphibasics.co.uk/RTL.php?Name=InputQuery#:~:text=The%20InputQuery%20function%20displays%20a,the%20return%20value%20is%20True.)
+- DelphiBasics: DateTime (https://www.delphibasics.co.uk/RTL.php?Name=formatdatetime)
+- Emabarcadero DocWiki: Cursors(https://docwiki.embarcadero.com/RADStudio/Alexandria/en/Mouse_Cursor_Constants)
+
+Special thanks to icons8.com for their contribution of the beautiful 3D Fluencency icon pack, which helped enhance the 
+program's modern style and appearance. Automated tools were utilized to generate lists of test data, playing a pivotal role in rigorously testing the application's functionality. Gratitude extends to the vibrant communities at StackOverflow and DelphiBasics for providing a wealth of questions and answers that have been instrumental in this project's development.
+
+Tested, developed, and delivered to you by:
+bellic-code

Assets/HelpFiles/AccountHelp.txt

@@ -0,0 +1,29 @@
+Account Help
+
+Common Errors:
+
+1.  Error: "You cannot delete the current user." 
+   -  Description:  This error occurs when you attempt to delete the account you are currently signed into.
+   -  Resolution:  To delete this account, please sign in to another administrator account and then try to delete the account.
+
+2.  Error: "No account selected. Please select an account from the account viewer to modify." 
+   -  Description:  This error message indicates that you are trying to perform an action, such as deletion, without selecting an account.
+   -  Resolution:  To select an account, simply click on a name, and it will become highlighted in blue.
+
+ Functions: 
+
+1.  Add Account 
+   -  Description:  This function redirects you to the "Create Account" tab, where you can register a new user.
+
+2.  Delete 
+   -  Description:  This function attempts to delete the currently selected account.
+   -  Usage:  Press 'Yes' to confirm the deletion and 'No' to cancel the operation.
+
+3.  Save 
+   -  Description:  This function saves any and all changes made to the accounts registered in the system.
+   -  Important:  Please note that there is no undo option after this point, so use it carefully.
+
+4.  Master Role Reset 
+   -  Description:  This function resets RetailEase back to its factory state.
+   -  Caution:  Be aware that this action will permanently remove all data from the system.
+   -  Warning:  Please proceed with caution.

Assets/HelpFiles/AddStockHelp.txt

@@ -0,0 +1,26 @@
+Modify/ Edit Stock Help
+
+ Common Errors: 
+
+1.  Category Field: 
+   -  Description:  Input is longer or shorter than 3 characters, or it contains forbidden characters such as [@, _, /, |], or the input field is empty.
+
+2.  Product Name Field: 
+   -  Description:  Input contains forbidden characters such as [@, _, /, |], or the input field is empty.
+
+3.  Price Field: 
+   -  Description:  Input is not a valid real value (e.g. 15.99), price inputted is greater than R1 000 000, or the input field is empty.
+
+ Functions: 
+
+1.  Preview 
+   -  Description:  Use this function to see what the entry will look like. You can press "Register Product" to approve it or edit it and preview again.
+
+2.  Reset 
+   -  Description:  This function clears the interface, allowing you to start fresh.
+
+3.  Reload Original Values 
+   -  Description:  This function will reset the values to the original values; i.e., what it looked like before being edited.
+
+4.  Cancel 
+   -  Description:  Use this function to discard all unsaved progress, return to the "Product Stock" interface, and make the "Accounts" tabsheet visible again.

Assets/HelpFiles/ChangeHelp.txt

@@ -0,0 +1,20 @@
+Change Help
+
+ Common Errors: 
+
+1.  Error: "Insufficient amount inputted." 
+   -  Description:  The amount given by the customer is smaller than the Grand Total. Hence, they cannot pay.
+
+2.  Error: "Invalid input. Please enter a valid numeric value." 
+   -  Description:  A non-numerical data type (e.g., abcd, 1234) has been inputted. Please make sure that the number is in decimal format (e.g., 12.34 instead of 12,34).
+
+ Functions: 
+
+1.  "Calculate Change" 
+   -  Description:  If conditions are met, the amount of change is calculated, displayed in the viewfinder, and added to the receipt to be printed.
+
+2.  "Clear Interface" 
+   -  Description:  The application will clear the interface and be ready for a new transaction.
+
+3.  "Print Receipt" 
+   -  Description:  The receipt slip is printed to a text file. Its location is shown after printing. The stock is saved, and there is no going back.

Assets/HelpFiles/CreateAccHelp.txt

@@ -0,0 +1,34 @@
+Create Account Help
+
+ Common Errors: 
+
+ Reasons for the Username Field Being Red: 
+1. Name contains forbidden characters: [._ ]
+2. Username does not match
+3. Field is empty
+
+ Reasons for the Passkey Field Being Red: 
+1. Passkey does not match
+
+ Functions: 
+
+1.  "Username" field: 
+   -  Description:  Enter the name you would like to use to sign in.
+
+2.  "Password" field: 
+   -  Description:  Enter the password to be used to authenticate and protect your account.
+
+3.  "Eye" (View/Hide Passkey): 
+   -  Description:  Allows the user to view the password as '  ' or in its clear text form, such as 'abcd'.
+
+4.  "Type of Account": 
+   -  Description:  Allows you to choose between Manager (providing higher-level access) or Cashier (providing lower-level access) for your account.
+
+5.  "Create Account": 
+   -  Description:  Registers the new account, assuming all conditions are met.
+
+6.  "Return to Login": 
+   -  Description:  Return to the Log In tabsheet.
+
+7.  "Return to Accounts": 
+   -  Description:  Return to the Accounts tabsheet.

Assets/HelpFiles/LoginHelp.txt

@@ -0,0 +1,18 @@
+Login Help
+
+ Common Errors: 
+
+1.  Error: "Incorrect username or password has been entered." 
+   -  Description:  Either the password or username is incorrect. Ensure the account is registered, and that the credentials have been inputted correctly.
+
+ Functions: 
+
+1.  Log In 
+   -  Description:  If the credentials match, you will be taken to the relevant page.
+
+2.  Create Account 
+   -  Description:  Will take you to the page to create an account.
+   -  Learn More:  Refer to Create Account Help for detailed instructions.
+
+3.  Eye (View/Hide Passkey) 
+   -  Description:  Used to view or hide passkey.

Assets/HelpFiles/RegisterHelp.txt

@@ -0,0 +1,35 @@
+Register Help
+
+ Common Errors: 
+
+1.  Error: "There is no stock in the catalogue." 
+   -  Description:  There is no registered stock. The app cannot perform its functions.
+   -  Resolution:  Please ask the manager to add some stock to the catalog.
+
+2.  Error: "Not enough stock available." 
+   -  Description:  The quantity requested is greater than the stock available.
+   -  Resolution:  Please register more stock to meet the demand.
+
+3.  Error: "Stock levels low." 
+   -  Description:  A warning that appears when stock is getting low, as decided by the minimum stock declared by the manager.
+
+4.  Error: "No stock remaining. Please contact supplier to order more stock." 
+   -  Description:  Stock level for the selected item is 0, and it cannot be bought.
+   -  Resolution:  Please contact the supplier to order more stock.
+
+5.  Error: "No item selected. Please select item from stock view finder to add to receipt." 
+   -  Description:  An item has not been selected from the stock view.
+   -  Resolution:  Please select an item (it will turn blue).
+
+ Functions: 
+
+1.  Add to Receipt 
+   -  Description:  Adds the currently selected item from the stock view to the receipt preview.
+   -  Tip:  Double-click on the receipt to add products faster.
+
+2.  Finalize Order 
+   -  Description:  Asks for the customer's name and finalizes the order, taking you to checkout.
+
+3.  Cancel Order 
+   -  Description:  Will cancel the current order.
+   -  Warning:  CANNOT BE UNDONE.

Assets/HelpFiles/StockHelp.txt

@@ -0,0 +1,26 @@
+Stock Help:
+
+ Common Errors: 
+
+1.  Error: "No stock has been selected." 
+   -  Description:  "No stock has been selected. Please select an item from the view finder to modify."
+   -  Resolution:  Please select an item from the list that displays all the stock. It will turn blue when selected.
+
+ Functions: 
+
+1.  Add Product 
+   -  Description:  Will take you to a separate page to add new stock.
+   -  Note:  Account tabsheet will become inaccessible.
+   -  Learn More:  Refer to 'Add Product Help' for detailed instructions.
+
+2.  Delete 
+   -  Description:  After selecting the desired stock to remove from the catalog, press 'Yes' on the dialog to confirm, and 'No' to cancel.
+   -  Important:  Ensure to click 'Save Changes' after, as changes are not automatically saved.
+
+3.  Save Changes 
+   -  Description:  Will save any modifications that have been made to the stock catalog.
+   -  Feedback:  You will receive a message showing that it was successfully saved.
+
+4.  Edit Stock 
+   -  Description:  Opens up a tabsheet to edit the currently selected item.
+   -  Note:  Account tabsheet will become inaccessible.

Assets/Phrases.txt

@@ -0,0 +1,12 @@
+Created by bellic-code
+RetailEase is an ease to use
+Icon pack by 3D Fluency
+Tip: The Lock will log you out
+Tip: You cannot delete the current user
+RetailEase was in development for more than two months!
+Tip: Use a '.' instead of ',' when entering prices
+Tip: Hit the enter key to sign in automatically
+Tip: The blue question mark is the help function
+Tip: Tabs disappear when editing an element
+Tip: App cannot be closed while editing or modifying an element.
+Tip: Minimum stock warns you that your supply levels are getting low

Receipts/README.txt

@@ -0,0 +1 @@
+This is where all receipts are stored :)

RetailEase_p.dpr

@@ -0,0 +1,14 @@
+program RetailEase_p;
+
+uses
+  Forms,
+  RetailEase_u in 'RetailEase_u.pas' {frmRetailEase};
+
+{$R *.res}
+
+begin
+  Application.Initialize;
+  Application.MainFormOnTaskbar := True;
+  Application.CreateForm(TfrmRetailEase, frmRetailEase);
+  Application.Run;
+end.