README.md 2.64 KB
Newer Older
1
2
Flowee the Hub repository
=========================
Colin Dean's avatar
Colin Dean committed
3

4
[![pipeline status](https://gitlab.com/FloweeTheHub/thehub/badges/master/pipeline.svg)](https://gitlab.com/FloweeTheHub/thehub/commits/master)
Colin Dean's avatar
Colin Dean committed
5

6
7
8
9
10
11
12
13
14
15
16

# Flowee is a series of applications to get the most out of Bitcoin Cash (BCH)

See more details on https://flowee.org/about/


This repository contains

* the Hub: the headless (server) Bitcoin Cash node software
* Indexer: Provides various data-stores to speed up lookups on the blockchain.
* Libraries shared between many of the Flowee applications.
Tom Zander's avatar
Tom Zander committed
17
18
19
20
21
22
* hub-cli: the command-line interface to the Hub server.
* bitcore-proxy: a client of hub+indexer to generate the bitcore APIs
* txVulcano: Transaction generator testing application.
* unspentdb: Application to introspect and optimize your UTXO database.
* Hub-qt: a test (gui) version of the Hub
* pos / cashier: a beta version of the point-of-sale application.
23

24
25
# Building a Hub that connects you to Bitcoin Cash

Tom Zander's avatar
Tom Zander committed
26
27
Bitcoin Cash is still a mysterious black box to most people and companies
that would potentially want to use it, or build applications with.
Colin Dean's avatar
Colin Dean committed
28

Tom Zander's avatar
Tom Zander committed
29
30
Flowee has been built to help you use Bitcoin Cash. Bring you a platform to
stand on when you simply use or when you build with Bitcoin Cash.
Colin Dean's avatar
Colin Dean committed
31

32
33
34
35
36
The codebase is derived from the one that originally was created by Satoshi
Nakamoto, the inventor of Bitcoin. This way you know you won't get
compatibility issues. Flowee is adjusted for greatly increased speed and
reliability as well as for scaling up to much larger blocks than the
competition.
rustyloy's avatar
rustyloy committed
37

Tom Zander's avatar
Tom Zander committed
38
# Installation
39

Tom Zander's avatar
Tom Zander committed
40
41
42
Binary packages are build by the continues integration system from GitLab.
Both debian packages and a simple zip file with executables are available
as artifacts for each 'pipeline':
43

Tom Zander's avatar
Tom Zander committed
44
45
46
https://gitlab.com/FloweeTheHub/thehub/-/pipelines?scope=branches

There is an ArchLinux AUR here: https://aur.archlinux.org/packages/flowee/
Colin Dean's avatar
Colin Dean committed
47

Tom Zander's avatar
Tom Zander committed
48
49
The simplest way to compile is by doing so in a docker container:
See more details [here](support/docker/hub).
Gavin Andresen's avatar
Gavin Andresen committed
50

Tom Zander's avatar
Tom Zander committed
51
**To compile and install Flowee** on Ubuntu, install the dependencies
Adam Brown's avatar
Adam Brown committed
52

53
`sudo apt install libevent-dev libboost-all-dev libminiupnpc-dev qt5-default libprotobuf-dev pkgconf`
Adam Brown's avatar
Adam Brown committed
54

Tom Zander's avatar
Tom Zander committed
55
To compile and install Flowee on MacOS, install the dependencies
Adam Brown's avatar
Adam Brown committed
56

57
`brew install cmake libevent boost miniupnpc qt pkg-config`
Adam Brown's avatar
Adam Brown committed
58

Tom Zander's avatar
Tom Zander committed
59
Then clone the repo and use cmake to create the makefile
Adam Brown's avatar
Adam Brown committed
60

Tom Zander's avatar
Tom Zander committed
61
62
63
64
65
66
67
```
mkdir thehub/build
cd thehub/build
cmake CMakeLists.txt ..
make
make install
```
Adam Brown's avatar
Adam Brown committed
68

Tom Zander's avatar
Tom Zander committed
69
70
71
72
73
The fastest way to try Flowee is by running a pre-compiled docker
container:
https://flowee.org/docs/deployment/


Adam Brown's avatar
Adam Brown committed
74
75
# More details

76
* https://flowee.org
Tom Zander's avatar
Tom Zander committed
77
* https://gitlab.com/FloweeTheHub/thehub
Adam Brown's avatar
Adam Brown committed
78
79
80

# Social

Tom Zander's avatar
Tom Zander committed
81
* Twitter: https://twitter.com/floweethehub