aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorndungudedan <[email protected]>2024-10-02 23:44:20 +0300
committerndungudedan <[email protected]>2024-10-02 23:44:20 +0300
commit368922f74fb843692dfd1503888b70f3026960e2 (patch)
treef2944d20dc2a331e7540f736edc6f48522a11242 /README.md
parent9aeb263fe5db34b048fd8a72bdda8206f58bb90b (diff)
downloadcoinos-ui-368922f74fb843692dfd1503888b70f3026960e2.tar.gz
coinos-ui-368922f74fb843692dfd1503888b70f3026960e2.zip
.env fix and Readme update
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 10 insertions, 2 deletions
diff --git a/README.md b/README.md
index f7dab808..414f39af 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.production` 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