Skip to content

Latest commit

 

History

History
124 lines (87 loc) · 4.1 KB

Readme.md

File metadata and controls

124 lines (87 loc) · 4.1 KB
Raw

POS - Next Generation Point Of Sale Application

Demo

site = http://pos.jawait.net

user = admin

pass = admin

Requirements

Backend Repository

POS-ws-server

Setting Up POS Project

  • Clone or fork POS to your computer
  • Use composer update command in POS root directory to tell composer to gather required dependencies for you
  • Import database from included sql file in database folder
  • Before viewing it on Browser, you must run sencha app build command in POS root directory to build POS Project

Building Project for Production

Use following command in POS root directory to build project

$ sencha app build

Database Scheme

Click here to view database scheme

Important Information

  • By default, POS will try to connect websocket at ws://pos.localhost:8080, so that means you have to set your POS development address to http://pos.localhost and make sure port 8080 is open. Edit these two file if you want to change default setting

    • Frontend: POS/app/fn/Util.js on line 19

      Ext.ws.Main = POS.fn.WebSocket.create('ws://pos.localhost:8080/POS/Mains');

    • Backend: POS-ws-server/bin/server.php on line 20

      $app = new App('pos.localhost', 8080);

    Important to note that the address and port on each file above must be identical or the connection will fail!

  • Default MySql database configuration:

    • host: "localhost"
    • database: "pos"
    • user: "root"
    • password: "sqlpass"

    Edit these two file if you want to change default setting

    • Frontend: POS/remote/propel-config.php
    • Backend: POS-ws-server/propel-config.php

Files and Folders

The following files are all needed to build and load the application.

  • "app.json" - The application descriptor which controls how the application is built and loaded.
  • "app.js" - The file that launches the application. This is primarily used to launch an instance of the MyApp.Application class.
  • "index.html" - The default web page for this application. This can be customized in "app.json".
  • "build.xml" - The entry point for Sencha Cmd to access the generated build script. This file is a place where you can hook into these processes and tune them. See the comments in that file for more information.
  • ".sencha" - This (typically hidden) folder contains the generated build scripts and configuration files for the application. This folder is required in order to build the application but its content should not need to be edited in most cases. The content of this folder is updated by "sencha app upgrade".

These files can be ignored from source control as they are regenerated by the build process.

  • "build" - This folder contain the output of the build. The generated CSS file, consolidated resources and concatenated JavaScript file are all stored in this folder.
  • "bootstrap.*" - These files are generated by the build and watch commands to enable the application to load in "development mode".

POS/app

This folder contains the JavaScript files for the application.

POS/resources

This folder contains static resources (typically an "images" folder as well).

POS/overrides

This folder contains override classes. All overrides in this folder will be automatically included in application builds if the target class of the override is loaded.

POS/sass

This folder contains the styling for the application's views. See POS/sass/Readme.md for details.

Future Development

See future development plan here