Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bailabs/tailpos

TailPOS an Offline First Open Source POS for ERPNext
https://github.com/bailabs/tailpos

android erpnext mobile-app mobx-react offline-first point-of-sale pos react react-native

Last synced: about 2 months ago
JSON representation

TailPOS an Offline First Open Source POS for ERPNext

Host: GitHub
URL: https://github.com/bailabs/tailpos
Owner: bailabs
License: gpl-3.0
Created: 2019-01-21T07:37:33.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2022-10-12T03:00:22.000Z (about 2 years ago)
Last Synced: 2024-08-01T12:19:49.056Z (5 months ago)
Topics: android, erpnext, mobile-app, mobx-react, offline-first, point-of-sale, pos, react, react-native
Language: JavaScript
Homepage:
Size: 16.2 MB
Stars: 438
Watchers: 35
Forks: 198
Open Issues: 25
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

awesome-frappe - TailPOS - Offline First Open Source POS for ERPNext. (Uncategorized / Uncategorized)

README

TailPOS

TailPOS an Offline First Open Source POS for ERPNext

### Showcase

![Showcase](showcase.gif)

### Features

o Two-way Sync to ERPNext
Two-way syncing to an ERPNext instance for a full suite of back-office functionalities.

o Offline-first Approach
Continue to make sales and keep running the business even no internet or unstable.

o Mobile POS
Uses the tablet for a lightweight setup. Built-in rear camera of the tablet can be used as a barcode scanner. Any bluetooth barcode scanner is compatible with `tailpos`

o Print receipts
Print sales receipts for customers using any ESC/POS receipt printer.

o Multiple payment modes
Can process credit card,mobile payments and cash.

o Discounts Program
Can apply discount to an invoice or on specific items.

o Inventory Management
Keep track of stock levels easily. Easy-to-use menu for item maintenance such as creating and updating item information.

o Sales Reports
Can generate X and Z readings and attendant shift sales totals.

### License
This project is released under the GPLv3 license, for more details, take a look at the LICENSE file in the source.

---

### Quick Start
A quick demo of syncing the `tailpos` to a Frappe/Erpnext server

https://docs.tailpos.com/tailpos/syncing-to-frappe-erpnext

##### Login to demo server
```
server: https://demo.tailerp.com
username: [email protected]
password: @Bailabs
```

##### **Making a new item.**

* Go To `Item` List.
* Make a new `Item`.
* Select your new `Item `to see its properties.

![alt text](https://github.com/bailabs/tailpos/blob/master/pics/item%20created.png)

* Select `Item Price` under `Pricing`.
Make sure the `In TailPOS` checkbox is checked.

![alt text](https://github.com/bailabs/tailpos/blob/master/pics/checkbox.png)

* Don't forget to save your Item.

##### **Setup TailPOS Sync Settings**
* Go to `Settings` > Sync
* Fill the following
```
ERPNext Server: demo.tailerp.com
Username: [email protected]
Password: @Bailabs
Device ID: <>
```
#### **Setting up device ID**
* Go to `Device` list.
* Create a new `Device`
* Input the `Device Name` and `POS Profile`
* Fill out information need in the `POS profile`
```
Name: <>
Series: ACC-SINV-.YYYY.-

Accounting
Write Off Accounting: Write Off – D
Write Off Cost Center: Main – D
```

![alt text](https://github.com/bailabs/tailpos/blob/master/pics/pos%20profile.png)

![alt text](https://github.com/bailabs/tailpos/blob/master/pics/write%20off.png)

* Select your new `Device`.
* `Device ID` is displayed at the top-right corner near the `Save` button.

![alt text](https://github.com/bailabs/tailpos/blob/master/pics/device%20name.png)

##### **Syncing**
* Once your done, save your `Sync Settings`.
* Press `Force Sync`.
* Once `Force Sync` is successful, go to your `Sales` tab and fill up a sample transaction.
* Confirm the transaction by looking at your `Receipts` tab.
* Now go back to your `Settings` > `Sync` and `Force Sync` the receipt data to the server.
* Verify by going to `Receipts` List in ERPNext and check the receipts if they are generated.

### How To Compile TailPOS in your local machine

If you are interested contributing the `tailpos`, the following guide will give you instructions in compiling the `tailpos`.

First, you'll need `nodejs` and `npm`:

```terminal
sudo apt install curl
curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
sudo apt-get install -y nodejs
nodejs -v
v8.4.0
```

Install development tools to build native addons:
```terminal
sudo apt-get install gcc g++ make
```
Install the `yarn` package manager, run:
```terminal
curl -sL https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
sudo apt-get update && sudo apt-get install yarn
```

Then you can install `react-native-cli` using `npm`

```terminal
sudo npm install -g react-native-cli
```

Now you need to install Java and Android

```terminal
sudo apt-get install default-jre
sudo apt-get install default-jdk

sudo add-apt-repository ppa:webupd8team/java
sudo apt-get update
sudo apt-get install oracle-java8-installer
```

* Install Android
* Install Android SDK requirements

```terminal
cd ~
mkdir android-sdk
cd android-sdk
wget https://dl.google.com/android/repository/sdk-tools-linux-3859397.zip
sudo apt-get install unzip
unzip sdk-tools-linux-3859397.zip
```

We add the path of our Android SDK tools to `.bashrc` so that we have access to the Android tools.
```
cd ~
nano .bashrc

# Add these lines to the top of the file
export ANDROID_HOME=$HOME/android-sdk
export PATH=$PATH:$ANDROID_HOME/tools
export PATH=$PATH:$ANDROID_HOME/tools/bin
export PATH=$PATH:$ANDROID_HOME/platform-tools

# CTRL+O (uppcase o) to save
# CTRL+X to exit

source ~/.bashrc
```

```terminal
android update sdk --no-ui
# Answer 'y' to all prompts

sdkmanager "platforms;android-23" "build-tools;23.0.1" "add-ons;addon-google_apis-google-23"
```

Installing TailPOS
```terminal
cd ~
mkdir Projects
cd Projects
git clone https://github.com/bailabs/tailpos.git
cd tailpos
yarn
```

Updating `react-native-camera` modules
* remove `buildscript` section

```terminal
buildscript {
repositories {
jcenter()
maven {
url 'https://maven.google.com'
}
}

dependencies {
classpath 'com.android.tools.build:gradle:3.0.0'
}
}
```

* `compileOnly` to `provided`
* `implementation` to `compile`

```terminal
cd ~
nano Projects/tailpos/node_modules/react-native-camera/android/build.gradle
```

Updating `react-native-maps` modules
* `compileOnly` to `provided`
* `implementation` to `compile`

```terminal
cd ~
nano Projects/tailpos/node_modules/react-native-maps/lib/android/build.gradle
```

Updating `react-native-bluetooth-serial` modules
* remove `@Override` in line 23 (the second `@Override`)

```terminal
cd ~
nano Projects/tailpos/node_modules/react-native-bluetooth-serial/android/src/main/java/com/rusel/RCTBluetoothSerial/RCTBluetoothSerialPackage.java
```

Updating `react-native-device-info` with `support-v4` fix
```
ERROR: In FontFamilyFont, unable to find attribute android:fontVariationSettings
ERROR: In FontFamilyFont, unable to find attribute android:ttcIndex
```
Set the following under `build.gradle` under `react-native-device-info`
```terminal
android {
compileSdkVersion 26
buildToolsVersion "26.0.2"
...
}

dependencies {
...
compile "com.google.android.gms:play-services-gcm:12.0.1"
compile "com.android.support:support-v4:27.1.0"
}
```

Update `react-native-localization`
* `implementation` to `compile`

Building `TailPOS`

```terminal
cd ~
cd Projects/tailpos
react-native run-android
```