POS AWESOME

An open-source Point of Sale for Erpnext using Vue.js and Vuetify (VERSION 15 Support)

---

Quick Start

Follow these steps to install and start using POS Awesome:

1. Install the app in your bench:

   1. bench get-app https://github.com/defendicon/POS-Awesome-V15
   2. bench setup requirements
   3. bench build --app posawesome
   4. bench restart
   5. bench --site your.site.name install-app posawesome
   6. bench --site your.site.name migrate

2. Open the POS Awesome workspace

   Log in to ERPNext, go to the home page, and click POS Awesome from the left-hand menu.

3. Create a POS Profile

   • Navigate to POS Awesome → POS Profile → New.
   • Fill in the mandatory fields:
     • Name – any label for this profile.
     • Company – the company under which transactions will be recorded.
     • Warehouse – the default warehouse for item stock deduction.
     • Customer – a default customer (create one if none exists).
     • Applicable for Users – add the users allowed to use this POS.
     • Payment Methods – add accepted modes (e.g., Cash, Card).

4. Save the profile

5. Start selling

   Return to the POS Awesome workspace and launch the POS. Select the newly created profile if prompted and begin creating invoices.

For more details, see the POS Awesome Wiki.

---

Update Instructions

After switching branches or pulling latest changes:

1. cd apps/posawesome
2. git pull
3. yarn install
4. cd ../..
5. bench build --app posawesome
6. bench --site your.site migrate

Go to developer tools in browser, then go to application tab, then go to storage and clear site data. After clearing site data go to browser settings and delete cache and images data in history also.

Main Features

1. Supports Erpnext Version 15
2. Supports Multi-Currency Transactions. Customers can be invoiced in different currencies. Exchange Rate is fetched automatically based on selected currency. When a price list has its own exchange rate set, POS Awesome uses that rate and falls back to the standard ERPNext rate otherwise. Invoices made with posawesome display Grand Total in both base and selected currency in erpnext.
3. Supports offline mode for creating invoices and customers, saves data locally with stock validation, and syncs automatically when reconnected. If Allow Negative Stock is enabled in Stock Settings, offline invoices can still be saved even when quantities are below zero. Enable browser local storage from settings and also enable the server cache for offline mode.
4. User-friendly and provides a good user experience and speed of use
5. The cashier can either use list view or card view during sales transactions. Card view shows the images of the items
6. Supports enqueue invoice submission after printing the receipt for faster processing
7. Supports batch & serial numbering
8. Supports batch-based pricing
9. Supports UOM-specific barcode and pricing
10. Supports sales of scale (weighted) products
11. Ability to make returns from POS
12. Supports Making returns for either cash or customer credit
13. Supports using customer credit notes for payment
14. Supports credit sales
15. Allows the user to choose a due date for credit sales
16. Supports customer loyalty points
17. Shortcut keys
18. Supports Customer Discount
19. Supports POS Offers
20. Auto-apply batches for bundle items
21. Search and add items by Serial Number
22. Create Sales Orders from POS directly
23. Supports template items with variants
24. Supports multiple languages with language selection per POS Profile (English, Arabic, Portuguese and Spanish provided)
25. Supports Mpesa mobile payment
26. POS Coupons
27. Supports Referral Code
28. Supports Customer and Customer Group price list
29. Supports Sales Person
30. Supports Delivery Charges
31. Search and add items by Batch Number
32. Accept new payments from customers against existing invoices
33. Payments Reconciliation
34. A lot more bug fixes from the version 14
35. Offline invoices that fail to submit are saved as draft documents

Shortcuts:

• CTRL or CMD + S open payments
• CTRL or CMD + X submit payments
• CTRL or CMD + D remove the first item from the top
• CTRL or CMD + A expand the first item from the top
• CTRL or CMD + E focus on discount field
• CTRL or CMD + B focus on customer search
• CTRL or CMD + I focus on item search field

---

Dependencies:

• Frappe
• Erpnext
• Vue.js
• Vuetify.js

---

Code Formatting

This project uses Prettier and Black for consistent formatting. To format locally before pushing changes, run:

yarn prettier --write "**/*.{js,vue,css,scss,html}"
pip install -r requirements-dev.txt
black .

These commands will rewrite files in-place so the CI checks pass.

---

Contributing

1. Issue Guidelines
2. Pull Request Requirements

---

License

GNU/General Public License (see license.txt)

The POS Awesome code is licensed as GNU General Public License (v3)