aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--.env.production2
-rw-r--r--.env.sample1
-rw-r--r--.gitignore1
-rw-r--r--README.md12
4 files changed, 13 insertions, 3 deletions
diff --git a/.env.production b/.env.production
index 49fc3425..9bceaa7a 100644
--- a/.env.production
+++ b/.env.production
@@ -6,4 +6,4 @@ PUBLIC_LIQUID_EXPLORER=https://liquid.network
PUBLIC_DOMAIN=coinos.io
PUBLIC_COINOS_PUBKEY=ba80990666ef0b6f4ba5059347beb13242921e54669e680064ca755256a1e3a6
PUBLIC_COINOS_RELAY=wss://relay.coinos.io
-PUBLIC_COINOS_NETWORK=bitcoin
+PUBLIC_COINOS_NETWORK=bitcoin \ No newline at end of file
diff --git a/.env.sample b/.env.sample
index c1a75688..8474ee0a 100644
--- a/.env.sample
+++ b/.env.sample
@@ -7,3 +7,4 @@ ORIGIN=http://localhost:5173
PUBLIC_DOMAIN=localhost:5173
PUBLIC_COINOS_PUBKEY=ba80990666ef0b6f4ba5059347beb13242921e54669e680064ca755256a1e3a6
PUBLIC_COINOS_RELAY=wss://relay.coinos.io
+PUBLIC_COINOS_NETWORK=regtest \ No newline at end of file
diff --git a/.gitignore b/.gitignore
index 10d98957..0ec58269 100644
--- a/.gitignore
+++ b/.gitignore
@@ -6,3 +6,4 @@ node_modules
.env
android
ios
+.history/ \ No newline at end of file
diff --git a/README.md b/README.md
index f7dab808..db6016ad 100644
--- a/README.md
+++ b/README.md
@@ -6,8 +6,16 @@ Coinos is a web-based bitcoin and nostr client. You can use it as a front end to
To get started, clone or download the repo, then:
- pnpm install
- pnpm run dev
+1. Create a `.env` file and copy the contents of `.env.sample` into it.
+2. Install the dependencies and run the app:
+
+ ```sh
+ bun install
+ bun run dev
+ ```
You'll need to run [`coinos-server`](https://github.com/coinos/coinos-server) as well
+# Docs
+
+Checkout the API documentation at: http://localhost:5173/docs \ No newline at end of file