posterstrudel/README.md
verita84 3b7c892b39
Some checks are pending
Docker image / build-and-push-image (push) Waiting to run
Update README.md
2024-09-17 18:16:47 -06:00

38 lines
1.5 KiB
Markdown

<p align="center">
<img src="https://s3.poster.place/poster-media/343c3c6abd27a307c9308bc3c3402dbd76dc5825d66b55368f3367062d6812b2.png" alt="Project Logo" width="100%">
</p>
# posterStudel
> NOTE: This client is still in development and will have bugs
noStrudel is a web app for exploring the [nostr](https://github.com/nostr-protocol) protocol.
The goal of this project is to build a nostr client that lets a user explore the nostr protocol by showing as much information as possible and letting the user view the underlying events.
Live Instance: [nostrudel.ninja](https://poster.place)
There are many features missing from this client and I wont get around to implementing everything. but if you like the client you are welcome to use it.
You can find more clients with more features on [nostrapps.com](https://www.nostrapps.com/) or in the [awesome-nostr](https://github.com/aljazceru/awesome-nostr) repo.
## Please don't trust my app with your nsec
While logging in with a secret key is supported. please don't. This is a web client, so there is always a chance of XXS attacks that could steal your secret key.
I would recommend you use a browser extension like [Alby](https://getalby.com/) or [Nos2x](https://github.com/fiatjaf/nos2x)
## Running locally
```bash
git clone https://git.poster.place/verita84/posterstrudel
cd nostrudel
yarn install
yarn dev
```
## Contributing
This is only a personal project, so if you open any PRs please keep them small. thanks