From 94584ff57ba86cbb2a6affad29a1efe62dfede99 Mon Sep 17 00:00:00 2001 From: Adam Soltys Date: Tue, 24 Jan 2023 13:11:13 -0800 Subject: readme update --- README.md | 38 +++++--------------------------------- 1 file changed, 5 insertions(+), 33 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 699bd928..ae2b09ec 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # coinos-server -Coinos is a bitcoin wallet app that supports payments over the bitcoin, liquid and lightning networks. Try it out at coinos.io. +Coinos is a bitcoin wallet app that supports payments over the bitcoin and lightning networks. Try it out at coinos.io. -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 here. +This repository contains the code for the API server. The frontend code is at https://github.com/coinos/coinos-ui-v2 ## Install @@ -11,39 +11,11 @@ The follow commands will set up bitcoin, liquid and lightning nodes in regtest m ```bash git clone https://github.com/coinos/coinos-server cd coinos-server -cp -r sampleconfig config cp -r sampledata data -mkdir uploads -sudo chown $(id -u):$(id -g) config/liquid -sudo chown $(id -u):$(id -g) config/bitcoin -cp .env.sample .env -cp fx.sample fx -docker network create net --gateway 172.18.0.1 --subnet 172.18.0.0/16 docker run -it -v $(pwd):/app --entrypoint pnpm asoltys/coinos-server i docker-compose up -d -docker exec -i maria mysql -u root -ppassword < db/schema.sql -docker exec -it bitcoin bitcoin-cli createwallet coinos -docker exec -it bitcoin bitcoin-cli rescanblockchain -docker exec -it bitcoin bitcoin-cli generatetoaddress 500 $(docker exec -it bitcoin bitcoin-cli getnewaddress "" "p2sh-segwit") -docker exec -it liquid elements-cli createwallet coinos -docker exec -it liquid elements-cli rescanblockchain -docker exec -it liquid elements-cli sendtoaddress AzpsKhC6xE9FEK4aWAzMnbvueMLiSa5ym1xpuYogFkHzWgMHSt8B79aNNbFppQzCSQ2yZ9E4nL6RQJU7 1000000 -docker exec -it liquid elements-cli generatetoaddress 1 AzpsKhC6xE9FEK4aWAzMnbvueMLiSa5ym1xpuYogFkHzWgMHSt8B79aNNbFppQzCSQ2yZ9E4nL6RQJU7 -curl localhost:3119/register -H "content-type: application/json" -d '{"user": { "username": "coinosfees", "password": "password"}}' +docker exec -it bc bitcoin-cli createwallet coinos +docker exec -it bc bitcoin-cli rescanblockchain +docker exec -it bc bitcoin-cli generatetoaddress 500 $(docker exec -it bitcoin bitcoin-cli getnewaddress "" "p2sh-segwit") ``` -After successful creation of all docker containers coinos ui will be available at http://localhost:8085 and coinos server will be available at http://localhost:3119 - -### License - -This code is [licensed]. Coinos is free for personal use. Anyone can fork as long as it stays AGPLv3. - -To purchase a commercial license or to inquire about customized, managed instances - please reach out to us at [contact@coinos.io] - - -[Config changes]:(#config-changes) -[config/lnd/lnd.conf]:./sampleconfig/lnd/lnd.conf -[pwd file]:./sampleconfig/lnd/pwd -[licensed]:./LICENSE.md -[contact@coinos.io]:mailto:contact@coinos.io -[generate some BTC]:./doc/fund-server-bitcoin-cli.md -- cgit v1.2.3