Files
thehub/README.md
T

80 lines
2.5 KiB
Markdown
Raw Permalink Normal View History

Flowee the Hub repository
=========================
2012-12-12 21:27:58 -05:00
[![pipeline status](https://gitlab.com/FloweeTheHub/thehub/badges/master/pipeline.svg)](https://gitlab.com/FloweeTheHub/thehub/commits/master)
2012-12-12 21:27:58 -05:00
# 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.
2020-06-29 22:34:07 +02:00
* 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.
# Building a Hub that connects you to Bitcoin Cash
2020-06-29 22:34:07 +02:00
Bitcoin Cash is still a mysterious black box to most people and companies
that would potentially want to use it, or build applications with.
2012-12-12 21:27:58 -05:00
2020-06-29 22:34:07 +02:00
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.
2012-12-12 21:27:58 -05:00
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.
2016-01-24 08:41:54 -05:00
2018-03-02 05:48:38 -05:00
# Installation
2012-12-12 21:27:58 -05:00
2020-06-29 22:34:07 +02:00
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':
2020-06-29 22:34:07 +02:00
https://gitlab.com/FloweeTheHub/thehub/-/pipelines?scope=branches
There is an ArchLinux AUR here: https://aur.archlinux.org/packages/flowee/
The simplest way to compile is by doing so in a docker container:
See more details [here](support/docker/hub).
**To compile and install Flowee** on Ubuntu, install the dependencies
2018-03-02 05:48:38 -05:00
2021-11-19 14:49:01 +01:00
`sudo apt install libssl-dev libevent-dev libboost-all-dev libminiupnpc-dev qt5-default libprotobuf-dev pkgconf`
2018-03-02 05:48:38 -05:00
2019-09-07 19:51:42 +02:00
To compile and install Flowee on MacOS, install the dependencies
2020-04-10 12:07:32 +02:00
`brew install cmake libevent boost miniupnpc qt pkg-config`
2019-09-07 19:51:42 +02:00
Then clone the repo and use cmake to create the makefile
2018-03-02 05:48:38 -05:00
2019-09-07 19:51:42 +02:00
```
mkdir thehub/build
cd thehub/build
cmake CMakeLists.txt ..
make
make install
```
2018-03-02 05:48:38 -05:00
2020-06-29 22:34:07 +02:00
The fastest way to try Flowee is by running a pre-compiled docker
container:
https://flowee.org/docs/deployment/
2018-03-02 05:48:38 -05:00
# More details
2019-06-23 09:16:05 +02:00
* https://flowee.org
2018-06-13 13:33:59 +02:00
* https://gitlab.com/FloweeTheHub/thehub
2018-03-02 05:48:38 -05:00
# Social
2018-06-13 13:33:59 +02:00
* Twitter: https://twitter.com/floweethehub