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 From 232cd9cc16a5aba5e5b2dc5c2c785bebe82cbccd Mon Sep 17 00:00:00 2001 From: Adam Soltys Date: Tue, 24 Jan 2023 13:32:35 -0800 Subject: simplify install --- README.md | 17 +++++++---------- setup.sh | 3 +++ 2 files changed, 10 insertions(+), 10 deletions(-) create mode 100644 setup.sh (limited to 'README.md') diff --git a/README.md b/README.md index ae2b09ec..f8ee2b9f 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,18 @@ # coinos-server -Coinos is a bitcoin wallet app that supports payments over the bitcoin and lightning networks. Try it out at coinos.io. +Coinos is a web-based bitcoin and nostr client. You can use it as a front end to your personal bitcoin and lightning nodes or host a public instance that allows anyone to register with a username and password. Try ours at https://coinos.io -This repository contains the code for the API server. The frontend code is at https://github.com/coinos/coinos-ui-v2 +This repository contains the code for the API server. The frontend code is at https://github.com/coinos/coinos-ui ## Install -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 docker installed as a pre-requisite. +The following commands will set up bitcoin and lightning nodes in regtest mode, along with a coinos api server and database. You'll need to have docker. ```bash -git clone https://github.com/coinos/coinos-server -cd coinos-server cp -r sampledata data -docker run -it -v $(pwd):/app --entrypoint pnpm asoltys/coinos-server i -docker-compose up -d -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") +docker compose up -d +docker run -it -v $(pwd):/app --entrypoint pnpm cs i +chmod +x setup.sh +./setup.sh ``` diff --git a/setup.sh b/setup.sh new file mode 100644 index 00000000..d18b5dba --- /dev/null +++ b/setup.sh @@ -0,0 +1,3 @@ +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") -- cgit v1.2.3 From 42f411b0852db1f24a78adc4ef040bd6577501e6 Mon Sep 17 00:00:00 2001 From: Adam Soltys Date: Tue, 24 Jan 2023 13:32:55 -0800 Subject: title --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index f8ee2b9f..4e6179ab 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# coinos-server +# Coinos Coinos is a web-based bitcoin and nostr client. You can use it as a front end to your personal bitcoin and lightning nodes or host a public instance that allows anyone to register with a username and password. Try ours at https://coinos.io -- cgit v1.2.3 From dcec2c0656d4fcb4e7713a46e39b1fccae915f2f Mon Sep 17 00:00:00 2001 From: Adam Soltys Date: Tue, 24 Jan 2023 13:41:36 -0800 Subject: readme --- README.md | 6 +----- setup.sh | 3 +++ 2 files changed, 4 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 4e6179ab..9215afae 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,9 @@ This repository contains the code for the API server. The frontend code is at docker. +Make sure you have docker then run the setup script: ```bash -cp -r sampledata data -docker compose up -d -docker run -it -v $(pwd):/app --entrypoint pnpm cs i chmod +x setup.sh ./setup.sh ``` - diff --git a/setup.sh b/setup.sh index d18b5dba..1f527f88 100644 --- a/setup.sh +++ b/setup.sh @@ -1,3 +1,6 @@ +cp -r sampledata data +docker compose up -d +docker run -it -v $(pwd):/app --entrypoint pnpm cs i 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") -- cgit v1.2.3