2019-12-20 16:34:21 +01:00
|
|
|
FloweeJS is a binding module enabling JavaScript developers to use the
|
2019-12-18 23:23:44 +01:00
|
|
|
Flowee applications and libraries with the NodeJS JavaScript engine.
|
2019-11-13 16:19:42 +01:00
|
|
|
|
2019-12-13 23:57:07 +01:00
|
|
|
Flowee is a family of products and our goal is to move the world towards
|
|
|
|
|
a Bitcoin Cash economy. FloweeJS works together with various other Flowee
|
|
|
|
|
products for the fastest and simplest way to build Bitcoin Cash products.
|
2019-11-13 16:19:42 +01:00
|
|
|
|
2019-12-20 16:34:21 +01:00
|
|
|
Using the online APIs, more people can get started with FloweeJS fast and
|
|
|
|
|
for free. Afraid of lock-in? No worry, the Flowee stack can be run on your
|
|
|
|
|
own server or on some cloud service, with ease. And again, free of charge.
|
|
|
|
|
|
2019-12-13 23:57:07 +01:00
|
|
|
|
|
|
|
|
The APIs are documented on [flowee.org/docs/floweejs](https://flowee.org/docs/floweejs)
|
2021-02-17 17:35:55 +01:00
|
|
|
and you can find our examples repo
|
|
|
|
|
[here](https://gitlab.com/FloweeTheHub/floweejs-examples/).
|
2019-11-13 16:19:42 +01:00
|
|
|
|
|
|
|
|
|
2019-12-13 23:57:07 +01:00
|
|
|
## Install
|
2019-11-13 16:19:42 +01:00
|
|
|
|
2019-12-13 23:57:07 +01:00
|
|
|
FloweeJS uses the nodejs bindings project in order to ensure that changes
|
|
|
|
|
in nodejs versions will be irrelevant. No recompiles needed.
|
|
|
|
|
This does mean that we have a minimum version of NodeJS (10.16 or later).
|
|
|
|
|
We always test on the latest version. Please report your experiences on
|
|
|
|
|
different versions!
|
|
|
|
|
|
|
|
|
|
To install the bindings you need to have available a C++ compiler,
|
|
|
|
|
the boost libs and the cmake tool.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
For Linux this means a simple;
|
2019-11-13 16:19:42 +01:00
|
|
|
```
|
|
|
|
|
apt-get install libboost-all-dev cmake
|
2019-12-13 23:57:07 +01:00
|
|
|
npm install floweejs
|
2019-11-13 16:19:42 +01:00
|
|
|
```
|
|
|
|
|
|
2019-12-13 23:57:07 +01:00
|
|
|
## Contributions
|
2019-11-13 16:19:42 +01:00
|
|
|
|
2019-12-13 23:57:07 +01:00
|
|
|
If you want to help out make this the best Javascript Bitcoin experience, you can find
|
|
|
|
|
all code, issues and website content on gitlab.
|
2019-11-13 16:19:42 +01:00
|
|
|
|
2019-12-13 23:57:07 +01:00
|
|
|
Questions and suggestions go here:
|
|
|
|
|
[https://gitlab.com/FloweeTheHub/issues](https://gitlab.com/FloweeTheHub/issues)
|
|
|
|
|
|
|
|
|
|
The Flowee main website is at: [Flowee.org](https://flowee.org)
|
|
|
|
|
|
|
|
|
|
Have fun!
|
