Menu ▾ ▴

Home

Ambrose Ariagiegbe

Welcome to POSChief wiki! This is not a complete document yet.

Our Mission Is:

To create an international open source point of sale that has all the features available in commercial products and even more.

Requirement

POSChief is web application and would need to be deployed into a web server. Basically the following must be present on the target system:
* Apache Web Server 2.2 or greater
+ MySQL database server
+ PHP 5 or greater

Installation Instruction

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

Features

  • Log-in mechanism.

  • User can add, edit, delete and search customers.

  • User can add, edit, delete and search items.

  • User can add, edit, delete and search item kits.

  • User can add, Update, Delete, and Search suppliers.

  • User can specify time frame and generate summary.

  • User can process receivings /returns.

  • User can process sales/returns.

  • User can add, edit, delete and search employees.

  • User can add, Update, Delete and Search gift cards.

  • User can change the software settings.

  • (Planned) User can create a support ticket using our ticketing system.

  • (Planned) User can broadcast emails to customers.

Bugs and Issues

To report a bug use the bug tracker at http://sourceforge.net/p/poschief/tickets/.

Community Participation

POSChief is maintained by Efomart Global Resources http://www.theictcenter.com, it's a true open-source project under the Grand Public License, Version 3.0. The community exists mainly through lists and a Subversion repository.

To participate: Go to http://sourceforge.net/p/poschief/mailman and join poschief-developer@list.sourceforge.net. This is where almost all discussion takes place. All development questions should go there, though you might want to check the archive first. You can also get a copy of the latest development sources from https://sourceforge.net/p/poschief/code/.

There are many ways to join the project, either by writing code, or by testing and/or helping to manage the bug database. If you'd like to contribute, then look at:
The bugs/issues database http://sourceforge.net/p/poschief/tickets/.

To submit code, simply send your patches to poschief-developer@list.sourceforge.net. If you are not sure about an issue, post a question to poschief-developer@list.sourceforge.net.

Finally, despite the online nature of this project, it is important to realize that there are real people at the end of all contributions. Treat all other community members as you would expect to be treated. Review the contribution, not the contributor; don't annoy others, and don't become easily annoyed yourself.

Understanding the Code

POSChief is a fork of Open Source Point-of-Sale project which is developed upon “Code Igniter” framework. We therefore recommend that you fully understand the architecture and structure of the framework before reading POSChief’s code. Check out CodeIgniter’s user-guide http://www.codeigniter.com/user_guide/.

Documentation

Every class and function, whether public or internal, must start with a documentation comment that describes what it does. For functions and methods, the input and return parameters must be specified.

Patches

Mail patches to poschief-developer@list.sourceforge.net, starting the subject line with [PATCH]. This helps us spot patches right away. If the patch addresses a known issue, include the issue number too e.g.
“[PATCH] issue #2324: …”
To learn more about patches read this article: http://www.oos-watch.ac.uk/resources/softwarepatch.xml.

Project Admins: