aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 157ca1675929daeab9b8dc1316b457da5843f424 (plain) (blame)
1
2
pre { line-height: 125%; }
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
.highlight .hll { background-color: #ffffcc }
.highlight .c { color: #888 } /* Comment */
.highlight .err { color: #A61717; background-color: #E3D
# 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

## Install

To get started, clone or download the repo, then:

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