blob: 01477f0e853f921bbaa5ffcc7ed2cc6e45d549e7 (
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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
|
# finserv
Local server for financial data.
## Build instructions
Only builds on Linux are supported. The Git [1] Meson build system [2] has to be
installed.
The source is retrieved with `git`.
```
git clone https://cgit.xengineering.eu/finserv
cd finserv
git submodule init
git submodule update
```
The build folder needs to be inside the source, needs to be named `build` and
is set up with `meson setup`.
```
meson setup build
```
A build is executed with `meson compile`. Missing software tools are reported
by Meson and must be installed for the build to succeed.
```
meson compile -C build
```
After a successful build the server executable can be started. The localhost
URL to access it is printed to the console.
```
./build/finserv-linux-amd64
```
## Public API declaration
The following elements are declared as the public API of this project as
required by Semantic Versioning [3]:
- command line arguments of the server executable
- HTTP API under the `/api` URL
Everything else is not part of the public API.
[1]: https://git-scm.com/
[2]: https://mesonbuild.com/
[3]: https://semver.org/spec/v2.0.0.html
|
