diff options
| author | Adam Soltys <[email protected]> | 2022-08-04 23:21:46 -0700 |
|---|---|---|
| committer | Adam Soltys <[email protected]> | 2022-08-04 23:21:46 -0700 |
| commit | d2eb6a7e4a83650802897364e42cc35df23db25e (patch) | |
| tree | 65ad83988c39f2ca8009438442d18bd99836fa9f /README.md | |
| parent | 777d1775d0bb7ad0481328ed2d8960003aaa7984 (diff) | |
| download | coinos-server-d2eb6a7e4a83650802897364e42cc35df23db25e.tar.gz coinos-server-d2eb6a7e4a83650802897364e42cc35df23db25e.zip | |
update readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 13 |
1 files changed, 3 insertions, 10 deletions
@@ -2,18 +2,11 @@ Coinos is a bitcoin wallet app that supports payments over the <a href="https://bitcoin.org">bitcoin</a>, <a href="https://blockstream.com/liquid/">liquid</a> and <a href="http://lightning.network/">lightning</a> networks. Try it out at <a href="https://coinos.io/">coinos.io</a>. -This repository contains the code for the backend API server which is implemented as a NodeJS application. The code for the frontend UI is tracked separately <a href="https://github.com/asoltys/coinos.io">here</a> (but is automatically installed & started via the Docker way outlined below). +This repository contains the code for the backend API server which is implemented as a NodeJS application. The code for the frontend UI is tracked separately <a href="https://github.com/asoltys/coinos.io">here</a>. -## Install/Run (the Docker way) +## Install -### Requirements - -* <a href="https://docs.docker.com/get-docker/ -">docker</a> and <a href="https://docs.docker.com/compose/install/">docker-compose</a> -* NodeJS (recommended version: 16) -* ~7GB of hard drive space (which will go into /var/lib/docker; primarily for Liquid) - -### Getting Started +The follow commands will set up bitcoin, liquid and lightning nodes in regtest mode, along with a coinos app server, database, and front end UI. You'll need to have <a href="https://docs.docker.com/get-docker/">docker</a> installed as a pre-requisite. ```bash git clone https://github.com/coinos/coinos-server |
