e1fedab9b7
- Refactored function names for PSR-12 compliance - Programmatically cascade delete attribute_link rows when a drop-down attribute is deleted but leave attribute_link rows associated with transactions. - Added `WHERE item_id IS NOT NULL` to migration to prevent failure on MySQL databases during migration - Retroactive correction of migration to prevent MySQL databases from failing. - Refactored generic functions to helper - Reverted attribute_links foreign key to ON DELETE RESTRICT which is required for a unique constraint on this table. Cascading deletes are now handled programmatically. - Migration Session table to match Code Igniter 4.6 - Add index to attribute_links to prevent query timeout in items view on large databases - Added overridePrefix() function to the migration_helper. Any time QueryBuilder is adding a prefix to the query when we don't want it to, this query can be used to override the prefix then set it back after you're done. - Added dropAllForeignKeyConstraints() helper function. - Added deleteIndex() helper function. - Added indexExists() helper function. - Added primaryKeyExists() helper function. - Added recreateForeignKeyConstraints() helper function. - Added CRUD section headings to the Attribute model. - Replaced `==` with `===` to prevent type juggling. - Removed unused delete_value function. - Reworked deleteDefinition() and deleteDefinitionList() functions to delete rows from the attribute_links table which are associated. - Added deleteAttributeLinksByDefinitionId() function Implement Cascading Delete - Function to delete attribute links with one or more attribute definitions. - Call function to implement an effective cascading delete. - Refactor function naming to meet PSR-12 conventions Fix Migration - Add drop of Generated Column to prevent failure of migration on MySQL databases. Fix Migration - Removed blank lines - Refactored function naming for PSR compliance - Reformatted code for PSR compliance - Added logic to drop dependent foreign key constraints before deleting an index then recreating them. Migrate ospos_sessions table - DROP and CREATE session table to prevent migration problems on populated databases Fixed Bug in Migration - In the event that item_id = null (e.g., it's a dropdown) it should not be included in the results. Fixed bug in Dropdown deletes - Removed delete_value function in Attributes Controller as it is unused. - Renamed postDelete_attribute_value function for PSR-12 compliance. - Renamed delete_value Attribute model function for PSR-12 compliance. - Refactored out function to getAttributeIdByValue - Replaced == with === to prevent type juggling - Reorganized parts of model to make it easier to find CRUD functions. Refactoring - PSR-12 Compliance formatting changes - Refactored several generic functions into the migration_helper.php - First check if primary key exists before attempting to create it. - Grouped functions together in migration_helper.php - phpdoc commenting functions Optimizing Indices - There are two queries run while opening the Items view which time out on large databases with weak hardware. These indices cut the query execution in half or better. Add Unique constraint back into attribute_links - This migration reverts ospos_attribute_links_ibfk_1 and 2 to ON DELETE RESTRICT. Cascade delete is done programmatically. This is needed to have a unique column on the attribute_links table which prevents duplicate attributes from begin created with the same item_id-attribute_id-definition_id combination Correct spacing after if for PSR-12 Minor code cleanup. - Removed Comments separating sections of code in Attribute model - Removed extra log line to prevent cluttering of the log
Open Source Point of Sale
Introduction · Demo · Installation · Contributing · Bugs · FAQ · Donate · License · Credits
👋 Introduction
Open Source Point of Sale is a web-based point of sale system. The application is written in PHP, uses MySQL (or MariaDB) as the data storage back-end, and has a simple but intuitive user interface.
The latest 3.4 version is a complete overhaul of the original software. It uses CodeIgniter 4 as a framework and is based on Bootstrap 3 using Bootswatch themes. Along with improved functionality and security.
The features include:
- Stock management (items and kits with an extensible list of attributes)
- VAT, GST, customer, and multi tiers taxation
- Sale register with transactions logging
- Quotation and invoicing
- Expenses logging
- Cash up function
- Printing and emailing of receipts, invoices and quotations
- Barcode generation and printing
- Database of customers and suppliers
- Multiuser with permission control
- Reporting on sales, orders, expenses, inventory status and more
- Receivings
- Gift cards
- Rewards
- Restaurant tables
- Messaging (SMS)
- Multilanguage
- Selectable Bootstrap based UI theme with Bootswatch
- MailChimp integration
- Optional Google reCAPTCHA to protect the login page from brute force attacks
- GDPR ready
🧪 Live Demo
We've got a live version of our latest master running for you to play around with and test everything out. It's a containerized install that will reinitialize when new functionality is merged into our code repository.
You can find the demo here and log in with these credentials.
👤 Username admin
🔒 Password pointofsale
If you bump into an issue, please check the status page here to confirm if the server is up and running.
🖥️ Development Demo
Besides the demo of the latest master, we also have a development server that builds when there's a new commit to our repository. It's mainly used for testing out new code before merging it into the master. It can be found here.
The log in credentials are the same as the regular live demo.
💾 Installation
Please refrain from creating issues about installation problems before having read the FAQ and going through existing GitHub issues. We have a build pipeline that checks the sanity of our latest repository commit, and in case the application itself is broken then our build will be as well.
This application can be set up in many different ways and we only support the ones described in the INSTALL.md file.
For more information and recommendations on support hardware, like receipt printers and barcode scanners, read this page on our wiki.
✨ Contributing
Everyone is more than welcome to help us improve this project. If you think you've got something to help us go forward, feel free to open a pull request or join the conversation on Element.
Want to help translate Open Source Point of Sale in your language? You can find our Weblate here, sign up, and start translating. You can subscribe to different languages to receive a notification once a new string is added or needs updating. Have a look at our guidelines below to help you get started.
Only with the help of the community, we can keep language translations up to date. Thanks!
🐛 Reporting Bugs
Before creating a new issue, you'll need copy and include the info under the System Info tab in the configuration section in most cases. If that information is not provided in full, your issue might be tagged as pending.
If you're reporting a potential security issue, please refer to our security policy found in the SECURITY.md file.
NOTE: If you're running non-release code, please make sure you always run the latest database upgrade script and download the latest master code.
📖 FAQ
-
If you get the message
system folder missing, then you have cloned the source using git and you need to run a build first. Check INSTALL.md for instructions or download latest zip file from GitHub releases instead. -
If at login time you read
The installation is not correct, check your php.ini file., please check the error_log inpublicfolder to understand what's wrong and make sure you read the INSTALL.md. To know how to enableerror_log, please read the comment in issue #1770. -
If you installed your OSPOS under a web server subdir, please edit
public/.htaccessand go to the lines with the commentsif in web rootorif in subdir, uncomment one and replace<OSPOS path>with your path, and follow the instruction on the second comment line. If you face more issues, please read issue #920 for more information. -
Apache server configurations are SysAdmin issues and not strictly related to OSPOS. Please make sure you can show a "Hello world" HTML page before pointing to OSPOS public directory. Make sure
.htaccessis correctly configured. -
If the avatar pictures are not shown in items or at item save you get an error, please make sure your
writableand subdirs are assigned to the correct owner and the access permission is set to750. -
If you install OSPOS in Docker behind a proxy that performs
ssloffloading, you can enable the URL generated to be HTTPS instead of HTTP, by activating the environment variableFORCE_HTTPS = 1. -
If you install OSPOS behind a proxy and OSPOS constantly drops your session, consider whitelisting the proxy IP address by setting
public array $proxyIPs = [];in the main PHP config file. -
If you have suhosin installed and face an issue with CSRF, please make sure you read issue #1492.
-
PHP
≥ 8.1is required to run this app.
🏃 Keep the Machine Running
If you like our project, please consider buying us a coffee through the button below so we can keep adding features.
Or refer to the FUNDING.yml file.
If you choose to deploy OSPOS in the cloud, you can contribute to the project by using DigitalOcean and signing up through our referral link. You'll receive a free $200, 60-day credit if you run OSPOS in a DigitalOcean droplet through our referral link.
📄 License
Open Source Point of Sale is licensed under MIT terms with an important addition:
The footer signature "© 2010 - current year · opensourcepos.org · 3.x.x - hash" including the version, hash and link to our website MUST BE RETAINED, MUST BE VISIBLE IN EVERY PAGE and CANNOT BE MODIFIED.
Also worth noting:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
For more details please read the LICENSE file.
It's important to understand that although you are free to use the application, the copyright has to stay and the license agreement applies in all cases. Therefore, any actions like:
- Removing LICENSE and/or any license files is prohibited
- Authoring the footer notice replacing it with your own or even worse claiming the copyright is absolutely prohibited
- Claiming full ownership of the code is prohibited
In short, you are free to use the application, but you cannot claim any property on it.
Any person or company found breaching the license agreement might find a bunch of monkeys at the door ready to destroy their servers.
🙏 Credits
DigitalOcean |
JetBrains |
Travis CI |
|---|---|---|
| Many thanks to DigitalOcean for providing the project with hosting credits. | Many thanks to JetBrains for providing a free license of IntelliJ IDEA to kindly support the development of OSPOS. | Many thanks to Travis CI for providing a free continuous integration service for open source projects. |