aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorAdam Soltys <[email protected]>2024-10-04 16:15:45 -0700
committerGitHub <[email protected]>2024-10-04 16:15:45 -0700
commit8ff6e6ff935b9fb08b8c20ac7527612d0a6b4396 (patch)
treeaecf1fb8d4a678120fc07155e652263ad97f5e8c /README.md
parent9aeb263fe5db34b048fd8a72bdda8206f58bb90b (diff)
parent78522bad144ce0a4352f492ac15bcafd4066a3b8 (diff)
downloadcoinos-ui-8ff6e6ff935b9fb08b8c20ac7527612d0a6b4396.tar.gz
coinos-ui-8ff6e6ff935b9fb08b8c20ac7527612d0a6b4396.zip
Merge pull request #125 from ndungudedan/master
.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..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