summaryrefslogtreecommitdiff
path: root/nexus/README
blob: 19af9703e9b2752b43af67d13cde8d40c59d7bed (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
Description
===========

The Libeufin Nexus implements a JSON API to let customers manages their
bank accounts.  The Nexus will then convert those requests sent by customers
into one of more technical protocols actually implemented by banks; notably,
EBICS and FinTS.

Running Nexus
=============

Run the Nexus with the following command

$ cd <top-level directory of this repository>
$ ./gradlew nexus:run --console=plain --args=serve [--db-name=<my-db>]

Installing the Nexus start script along the project files
=========================================================

$ cd <top-level directory of this repository>
$ ./gradlew -q -Pprefix=<installation prefix> nexus:installToPrefix

If the previous step succeeded, the nexus can be launched by the
following file: "<installation prefix>/bin/libeufin-nexus".

Documentation
=============

See https://docs.libeufin.tech/ for the documentation.