a nostr web interface in vanilla JS https://nostr.ch/

You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Go to file

alex e238bd9018 ci/woodpecker/pr/woodpecker Pipeline was successful Details ci/woodpecker/push/woodpecker Pipeline was successful Details add an about page this is a simple static text page showing current version from the npm package and git commit hash at which the app was built. it's served at /about.html but i didn't link it from the root. not sure where the best place is.		2 years ago
src	add an about page	2 years ago
tools	add an about page	2 years ago
.gitignore	initial	2 years ago
.woodpecker.yml	add an about page	2 years ago
LICENSE	initial	2 years ago
README.md	docs: clarify how the live instance is currently updated from the CI	2 years ago
esbuildconf.js	add an about page	2 years ago
package-lock.json	0.0.8	2 years ago
package.json	0.0.8	2 years ago

README.md

nostr web sandbox

a playground for a web interface to nostr. some useful resources:

JS library used in this project: https://github.com/fiatjaf/nostr-tools
NIPs: https://github.com/nostr-protocol/nips
relays registry: https://nostr-registry.netlify.app/
event inspector: https://nostr.com/
a working web interface in vue.js: https://astral.ninja/
https://github.com/aljazceru/awesome-nostr

dev

nodejs v18.x and npm v8.x are recommended.

after npm install, start by running a dev server with:

npm run serve

and point a browser to http://127.0.0.1:8001/

the serve command injects a live reload snippet. to build a "production" copy, execute

npm run build

the build is done using esbuild, with a config in esbuildconf.js. the result is placed in dist directory.

release

make sure version field in package.json as seen by remote git on master branch matches the tag created in the next step.
tag a commit on master branch with a git tag v<vesion>.
push the tag to the remote: git push --tags.

the CI then receives a git tag event, executes npm run build, creates a tar.gz with all the files found in dist directory and uploads it as a new release artifact. the release is named after the tag name.

the idea is that nostr web instances are then notified about a new release, download the tar.gz archive and update their local copies. this is not yet implemented. at the moment, the CI symply rsync's dist/ with a remote on https://nostr.ch.