aboutsummaryrefslogtreecommitdiff
path: root/README
blob: 0a7da175c303632e4235d8090f4a2db96088c953 (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
53
54
55
Web UI for arching-kaos
-----------------------

This repository hosts the html, css and js files for presenting "arching-kaos"
to visitors.

## Visit the demo pages
For demo, you can visit https://arching-kaos.net .

### All demo links (may vary on running versions)
- [Net](https://arching-kaos.net),
- [Com](https://arching-kaos.com),
- [Xyz](https://arching-kaos.xyz),
- [News](https://news.arching-kaos.net)
- [Dev](https://dev.arching-kaos.net)

## Usage
1) You will need to clone the repository,
2) host the files on a HTTP server,
3) make a SSL certificate (is needed for Stellar connectivity) for your server,
4) edit `js/arching-kaos-web-ui-settings.js` to match your desired links.

## Development workflow proposal (how I 've done it so far)
Instead of serving the files statically on a server, I use IPFS and fetch them
from a public IPFS gateway that I've set up for the project.

The workflow would be like:

```
git clone https://github.com/arching-kaos/arching-kaos-web-ui
cd arching-kaos-web-ui
xdg-open http://127.0.0.1:8080/$(ipfs add -Q -r src)
```

Then you can edit as far as you want and see your changes by issuing the
following command.
```
xdg-open http://127.0.0.1:8080/$(ipfs add -Q -r src)
```

Of course, `http://127.0.0.1:8080/` should be replaced in both cases with your
remote IPFS gateway.

## Notes

If you are trying to view the same results as in the demo pages but from a
public IPFS gateway, you may fail. Your IPFS nodes need to be in the same swarm
as the one Arching Kaos is operating at. For that, you will need to install
[arching-kaos-tools](https://github.com/arching-kaos/arching-kaos-tools). You
can also remove or change swarm to start your own network.

## Contribute

1. Did you find a bug? Report it by opening an issue.
2. Did you code it better? Open a pull request.