Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jinglescode/nostr-url-shortener
A free URL shortener service enabled by the NOSTR protocol, that is fast and fuss-free, stripped of all bells and whistles, no gimmicks—it just works!
https://github.com/jinglescode/nostr-url-shortener
nostr
Last synced: 3 days ago
JSON representation
A free URL shortener service enabled by the NOSTR protocol, that is fast and fuss-free, stripped of all bells and whistles, no gimmicks—it just works!
- Host: GitHub
- URL: https://github.com/jinglescode/nostr-url-shortener
- Owner: jinglescode
- License: mit
- Created: 2023-08-12T09:57:49.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-26T02:08:59.000Z (25 days ago)
- Last Synced: 2024-12-11T17:45:48.624Z (10 days ago)
- Topics: nostr
- Language: TypeScript
- Homepage: https://w3.do
- Size: 109 KB
- Stars: 71
- Watchers: 2
- Forks: 14
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- starred - jinglescode/nostr-url-shortener - A free URL shortener service enabled by the NOSTR protocol, that is fast and fuss-free, stripped of all bells and whistles, no gimmicks—it just works! (TypeScript)
README
# w3.do - URL Shortener on NOSTR Network
A free URL shortener service enabled by the NOSTR protocol, that is fast and fuss-free, stripped of all bells and whistles, no gimmicks—it just works!
Visit [w3.do](https://w3.do), the URL shortener service enabled by the NOSTR protocol.
### Kind 1994
```
const id = nanoid(8);
const event = new NDKEvent();
event.kind = 1994;
event.tags = [
["d", id],
["r", ''],
];
```
Why 1994?
Because URLs (Uniform Resource Locators) were defined in 1994 by Tim Berners-Lee, the inventor of the World Wide Web. [[source: Wikipedia](https://en.wikipedia.org/wiki)]
### NOSTR NIP-19 redirects njump.me
Using a bech32 formatted string according to [NIP-19](https://github.com/nostr-protocol/nips/blob/master/19.md) as input will generate a shortened URL that redirects to [njump.me](https://njump.me).
This includes: `nevent1`, `note1`, `npub1`, `nprofile1`, `naddr1`.
For instance, when the input `npub1alpha9l6f7kk08jxfdaxrpqqnd7vwcz6e6cvtattgexjhxr2vrcqk86dsn` is provided, it generates a shortened URL, [w3.do/ig2FmnQY](https://w3.do/ig2FmnQY), which redirects to [njump.me/npub1alpha9l6f7kk08jxfdaxrpqqnd7vwcz6e6cvtattgexjhxr2vrcqk86dsn](https://njump.me/npub1alpha9l6f7kk08jxfdaxrpqqnd7vwcz6e6cvtattgexjhxr2vrcqk86dsn).
## REST API
### Create a short URL
You can use this API to create a short URL.
```
GET https://w3.do/get?url=
```
For example: [https://w3.do/get?url=https://github.com/jinglescode/nostr-url-shortener](https://w3.do/get?url=https://github.com/jinglescode/nostr-url-shortener)
This will return a JSON response, for example:
```
{
"id":"xNQ8b0HZ",
"url":"w3.do/xNQ8b0HZ",
"eid":"a62729f9e11506183672f1e37bc4617af94636169b3c5b25db6c16b0cd05fbf1"
}
```
### Check if a short URL exists
```
GET https://w3.do/check?url=
```
Example: [https://w3.do/check?url=https://github.com/jinglescode/nostr-url-shortener](https://w3.do/check?url=https://github.com/jinglescode/nostr-url-shortener)
### Check using ID
```
GET https://w3.do/check?id=
```
Example: [https://w3.do/check?id=MSbbaU8l](https://w3.do/check?id=MSbbaU8l)
### Get all links by pubkey
```
GET https://w3.do/check?pubkey=
```
Example: [https://w3.do/check?pubkey=efc37e97fa4fad679e464b7a6184009b7cc7605aceb0c5f56b464d2b986a60f0](https://w3.do/check?pubkey=efc37e97fa4fad679e464b7a6184009b7cc7605aceb0c5f56b464d2b986a60f0)
## Support this project
- [Fund Raiser](https://geyser.fund/project/url/) - Join the global community to support project on Geyser Fund, a crowdfunding platform. The funds will be used to pay for contributors and bounties.
- [Contribute](https://github.com/jinglescode/nostr-password-manager/pulls) - Contribute directly by submitting a pull request.
- [Try it and share it](https://w3.do/) - Try the URL shortener service and share it.
## Potential features
- support to handle nostr slugs, like nevent, npub, note, nprofile
- something about njump? https://github.com/fiatjaf/njump
- use bech32 too, use nip89 to store user preferred client
## Contributors
