posterstrudel/README.md

43 lines
1.6 KiB
Markdown
Raw Normal View History

2024-09-17 18:10:51 -06:00
<p align="center">
2024-09-17 18:15:48 -06:00
<img src="https://s3.poster.place/poster-media/343c3c6abd27a307c9308bc3c3402dbd76dc5825d66b55368f3367062d6812b2.png" alt="Project Logo" width="100%">
2024-09-17 18:10:51 -06:00
</p>
2024-09-17 18:13:06 -06:00
# posterStudel
2024-09-17 18:10:51 -06:00
> NOTE: This client is still in development and will have bugs
2024-09-17 18:19:54 -06:00
posterStrudel is a web app for exploring the [nostr](https://github.com/nostr-protocol) protocol.
2024-09-17 18:10:51 -06:00
2024-09-17 18:41:48 -06:00
Live Instance: [poster.place](https://poster.place)
2024-09-17 18:10:51 -06:00
2024-09-17 18:19:54 -06:00
## This is a fork of the [Nostrudel Project](https://nostrudel.ninja) with the following changes:
* Simpler Sign-on with Browser Extension only
* Simpler Naviation Menu - Removed all non-essential items
2024-09-17 18:23:53 -06:00
* Global Timeline is now default = using [relay.poster.place](https://relay.poster.place) as the only relay with massive spam filtering
* Better Keyboard Shortcuts for navigation
* Removed VIM keyboard shortcuts from Reply since it ruins the experience
* Post modeal disappears after posting
* Ability to block a spammer by viewing their profile on the Relay itself
* Adds client tag to the posts by default
* Sets default blossom server to [Poster.place Blossom](https://blossom.poster.place) with the following changes:
* ChakraUI is the default theme
2024-09-17 18:10:51 -06:00
2024-09-17 19:09:04 -06:00
## A Browser Extension is Required to Log in.
2024-09-17 18:10:51 -06:00
2024-09-17 19:09:04 -06:00
I would recommend you use a browser extension like [Alby](https://getalby.com/) or [Nostr Connect](https://github.com/reyamir/nostr-connect)
2024-09-17 18:10:51 -06:00
## Running locally
```bash
2024-09-17 18:16:47 -06:00
git clone https://git.poster.place/verita84/posterstrudel
2024-09-17 18:50:55 -06:00
cd posterstrudel
2024-09-17 18:10:51 -06:00
yarn install
yarn dev
```
## Contributing
This is only a personal project, so if you open any PRs please keep them small. thanks