Go to file
verita84 fe3bed037e
Some checks are pending
Docker image / build-and-push-image (push) Waiting to run
Update README.md
2024-09-17 18:15:48 -06:00
.changeset first commit 2024-09-17 18:11:55 -06:00
.github/workflows first commit 2024-09-17 18:11:55 -06:00
.vscode first commit 2024-09-17 18:11:55 -06:00
public first commit 2024-09-17 18:11:08 -06:00
screenshots first commit 2024-09-17 18:11:08 -06:00
scripts first commit 2024-09-17 18:11:08 -06:00
server first commit 2024-09-17 18:11:08 -06:00
src first commit 2024-09-17 18:11:08 -06:00
.dockerignore first commit 2024-09-17 18:11:55 -06:00
.gitignore first commit 2024-09-17 18:11:55 -06:00
.nvmrc fix 2024-09-17 18:12:06 -06:00
.prettierignore first commit 2024-09-17 18:11:55 -06:00
.prettierrc first commit 2024-09-17 18:11:55 -06:00
=2.0.0 first commit 2024-09-17 18:11:08 -06:00
build.sh first commit 2024-09-17 18:11:08 -06:00
CHANGELOG.md first commit 2024-09-17 18:11:08 -06:00
CNAME first commit 2024-09-17 18:11:08 -06:00
CONTRIBUTING.md first commit 2024-09-17 18:11:08 -06:00
docker-compose.yaml first commit 2024-09-17 18:11:08 -06:00
docker-entrypoint.sh first commit 2024-09-17 18:11:08 -06:00
dockerfile first commit 2024-09-17 18:11:08 -06:00
index.html first commit 2024-09-17 18:11:08 -06:00
LICENSE first commit 2024-09-17 18:11:08 -06:00
maintainers.yaml first commit 2024-09-17 18:11:08 -06:00
package.json first commit 2024-09-17 18:11:08 -06:00
README.md Update README.md 2024-09-17 18:15:48 -06:00
tsconfig.json first commit 2024-09-17 18:11:08 -06:00
vite.config.ts first commit 2024-09-17 18:11:08 -06:00
yarn.lock first commit 2024-09-17 18:11:08 -06:00

Project Logo

posterStudel

NOTE: This client is still in development and will have bugs

noStrudel is a web app for exploring the nostr 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

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 or in the 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 or Nos2x

Running with docker

docker run --rm -p 8080:80 ghcr.io/hzrd149/nostrudel:master

Docker compose and other services

noStrudels docker image has a few options for connecting to other services running locally

  • CACHE_RELAY: if set the client will use the relay to cache all of its events instead of storing them in the browser cache
  • IMAGE_PROXY: can be set to a local imageproxy instance so the app can resize profile images
  • REQUEST_PROXY: can be set to a local cors-anywhere instance so the app can proxy http request
  • PROXY_FIRST: if this is set to true all http requests will go through the request proxy first

You can find a full example of all these services in the docker-compose.yaml

Running locally

git clone git@github.com:hzrd149/nostrudel.git
cd nostrudel
yarn install
yarn dev

Contributing

This is only a personal project, so if you open any PRs please keep them small. thanks