Flowee Pay. A cross-platform wallet using the Flowee libraries. https://flowee.org/products/pay/
 
 
 
 
 
 
Go to file
Tom Zander 81861f7cc5 Follow refactor in Payment 2023-09-06 21:07:30 +02:00
android New version 2023-09-06 16:22:33 +02:00
data Import all official wordlists 2021-11-19 13:45:57 +01:00
guis Limit menu-opening gesture to mobile 2023-09-06 16:22:21 +02:00
modules Follow refactor in Payment 2023-09-06 21:07:30 +02:00
src New version 2023-09-06 16:22:33 +02:00
testing Bugfix how we handle numbers from user input 2023-06-23 10:35:35 +02:00
translations fetch updates from Crowdin 2023-08-28 21:05:23 +02:00
.gitignore Move the Netview to a module of its own: Peers-view 2023-07-04 22:35:58 +02:00
CMakeLists.txt Cleanups of old CMake stuff 2023-08-27 18:48:30 +02:00
LICENSE first commit 2020-05-24 13:16:47 +02:00
README.md Add link to readme 2022-12-21 16:18:59 +01:00

README.md

This is the repository of Flowee Pay.

Flowee Pay is a payment solution, also often called wallet, that allows users to pay and receive Bitcoin Cash in a simple application with little to no external parties or (indexing) servers it needs to depend on. The only really required dependent is the peer to peer network, and thus the Internet.

We use QML for the user interface, which allows fast turnaround for skinning and a very strong model/view separation. The goal here is to have multiple user interfaces for the one codebase. For instance you can have a very different user experience and set of features on desktop than on Android. You can simply "skin" an existing GUI and change it to have your companies logo (we want you to do that! Just please use a different name for the app you ship then!)

The goal of having a Free Software product like Flowee Pay is that average users can use the community client and when companies that want to bundle a wallet with their product (for instance to do some token thingy) they are more than welcome to provide their own skinning instead of the ones that are included in this repo.

Any companies or groups doing this are going to help increase the quality of the main free software product and thus this benefits all.

BUILDING

Flowee Pay uses libraries from Flowee, you need to either install the main flowee package via your package manager or compile it before you compile Pay. The minimum version required for the Flowee libraries is 2022.07.0

For ubuntu getting the latest is a matter of calling:

  sudo add-apt-repository ppa:flowee/ppa
  sudo apt update
  sudo apt install flowee-libs

Additionally you will want to have some development packages installed;

    sudo apt install build-essential libboost-all-dev libssl-dev cmake \
        qt6-tools-dev-tools qt6-tools-dev qt6-declarative-dev libqrencode-dev \
        libqt6svg6-dev

After installing that succesfull, it is just a matter of calling:

  mkdir build
  cd build
  cmake ..
  make install

Manually compiling flowee-libs:

We depend on the libraries shipped in 'theHub' git repo, also from Flowee. If you compile that yourself, you need to make sure you make install it. The Flowee Pay buildsystem may not find this if the install directory is not the same as the packaged. In that case you may want to replace the cmake call above with this slightly more complex one:

   cmake -DCMAKE_PREFIX_PATH=/path/to/the/thehub-installed-dir ..

DEVS

Want to start Hacking, getting to know QML as well? Here is a video playlist of 5 short videos explaining the tech youtube

To develop on the app, especially if you will work on the QML, we suggest the following workflow:

  mkdir build
  cd build
  cmake -Dlocal_qml=ON -DCMAKE_INSTALL_PREFIX=`pwd` ..
  make install

The executables will be in floweepay/build/bin/ and by adding the local_qml cmake option the build will bake in the path to your QML files. On your local harddrive. This allows you to change the QML files and simply restart the app without recompile.

For development you can run either pay or pay_mobile, depending on which front-end you are working on.

To develop on the app we suggest starting one of those app with these options:
bin/pay --offline --testnet4

Links