https://github.com/decimoseptimo/huizar-pos
A web GUI with a RESTful API where data can be fed to. Made with Yii2.
https://github.com/decimoseptimo/huizar-pos
gui php pos restful web-application
Last synced: 2 months ago
JSON representation
A web GUI with a RESTful API where data can be fed to. Made with Yii2.
- Host: GitHub
- URL: https://github.com/decimoseptimo/huizar-pos
- Owner: decimoseptimo
- License: other
- Created: 2016-08-10T19:26:19.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-03-18T00:36:50.000Z (about 7 years ago)
- Last Synced: 2023-10-15T23:26:32.095Z (over 1 year ago)
- Topics: gui, php, pos, restful, web-application
- Language: PHP
- Homepage:
- Size: 183 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Huizar-POS
A web GUI with a RESTful API where data can be fed to.
It has two main entry points: `/web` the GUI and `/api` the RESTful server .
## Demo
http://www.azulacero.mx/huizar-pos/
## Requirements
* Yii 2.x (PHP 5.4.0)
* MySQL
* Composer
## Instructions
* Deploy to server and instruct composer to install dependencies
* Setup /config/db.php with your DB credentials
* Setup /config/params.php with your ESP credentials
Either:
* Run migrations in /migrations folder
* Or import /sample.sql (e.g. `mysql -u MYSQL_USER -p DB_NAME < PATH_TO_SAMPLE.SQL`)
## TODO
- [x] Implement migrations
- [x] Add RESTful API for managing customers and orders
- [x] Implement ESP APIs to send email
- [x] Design HTML template(s)
- [x] Add access control
- [ ] Integrate order search to website
## API
##### Customers
* POST /api/v1/customers
* PUT/PATCH /api/v1/customers/{id}
* DELETE /api/v1/customers/{id}
_Model_
```js
Customers {
id (integer, unique),
first_name (string),
last_name (string),
email (string, unique),
}
```
##### Orders
* POST /api/v1/orders
* PUT/PATCH /api/v1/orders/{id}
* DELETE /api/v1/orders/{id}
_Model_
```js
Orders {
id (integer, unique),
status (string, accepted-values=('recibido' | 'finalizado' | 'entregado'), case-sensitive),
customer_id (integer, referenced 'Customer' must have been submitted),
}
```
Bulk submission is not supported at any API endpoint.