gitter-badger / opensourcepos Goto Github PK

Introduction

Open Source Point of Sale is a web based point of sale system written in the PHP language. It uses MySQL as the data storage back-end and has a simple user interface.

This is the latest version 3.0.0 and it's based on Bootstrap 3 using Bootswatch theme Flatly as default, and CodeIgniter 3.0.6.

Badges

Keep the Machine Running

If you like the project, and you are making money out of it on a daily basis, then consider buying me a coffee so I can keep adding features.

Server Requirements

PHP version 5.5 or newer is recommended but PHP 7.x is not fully supported yet.

Reporting Bugs

Since OSPOS 3.0.0 is a version under development, please make sure you always run the latest 2.4_to_3.0.sql database upgrade script. Please DO NOT post issues if you have not done that before running OSPOS 3.0. Please also make sure you have updated all the files from latest master.

Bug reports must follow this schema:

1. OS name and version running your Web Server (e.g. Linux Ubuntu 15.0)
2. Web Server name and version (e.g. Apache 2.4)
3. Database name and version (e.g. MySQL 5.6)
4. PHP version (e.g. PHP 5.5)
5. Language selected in OSPOS (e.g. English, Spanish)
6. Any configuration of OSPOS that you changed
7. Exact steps to reproduce the issue (test case)

If above information is not provided in full, your issue will be tagged as pending. If missing information is not provided within a week we will close your issue.

Installation

1. Create/locate a new mysql database to install open source point of sale into
2. Execute the file database/database.sql to create the tables needed
3. unzip and upload Open Source Point of Sale files to web server
4. Copy application/config/database.php.tmpl to application/config/database.php
5. Modify application/config/database.php to connect to your database
6. Modify application/config/config.php encryption key with your own
7. Go to your point of sale install via the browser
8. LOGIN using username: admin password:pointofsale
9. Enjoy

FAQ

If a blank page (HTTP status 500) shows after search completion or receipt generation, then double check php5-gd presence in your php installation. On windows check in php.ini whether the lib is installed. On Ubuntu issue sudo apt-get install php5-gd. Also have a look at the Dockerfile for a complete list of recommended packages.

13/01/2016: Install using Docker

From now on ospos can be deployed using Docker on Linux, Mac or Windows. This setup dramatically reduces the number of possible issues as all setup is now done in a Dockerfile. Docker runs natively on mac and linux, but will require more overhead on windows. Please refer to the docker documentation for instructions on how to set it up on your platform.

To build and run the image, issue following commands in a terminal with docker installed

docker build -t me/ospos https://github.com/jekkos/opensourcepos.git
docker run -d -p 80:80 me/ospos

Docker will clone the latest master into the image and start a LAMP stack with the application configured. If you like to persist your changes in this install, then you can use two docker data containers to store database and filesystem changes. In this case you will need following command (first time only)

docker run -d -v /app --name="ospos" -v /var/lib/mysql --name="ospos-sql" -p 127.0.0.1:80:80 me/ospos

After stopping the created container for the first time, this command will be replaced with

docker run -d -v /app --volumes-from="ospos" -v /var/lib/mysql --volumes-from="ospos-sql" -p 127.0.0.1:80:80 me/ospos

Both the data and mysql directories will be persisted in a separate docker container and can be mounted within any other container using the last command. A more extensive setup guide can be found at this site