Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/eskema/alphaama

A<3
https://github.com/eskema/alphaama

nostr

Last synced: 12 days ago
JSON representation

A<3

Awesome Lists containing this project

README 

        
= alphaama is just aa nostr fucking client



dat:



* tries to be fun and weird.

* let's you interact with nostr exposing the protocol instead of abstracting it.

* tries to be minimalistic, flexible and powerful.

* doesn't do it all yet, soon™.

* is not for everyone.

* keeps changing in breaking ways.

* has bugs and bad decisions.

* is a learning tool.

* is written in vanilla js, html and css.

* is public domain, free and open-source.

* you can do whatever the fuck you want with it.



source code:

https://github.com/eskema/alphaama



nostr:

https://github.com/nostr-protocol/nostr



work in progress dev deployment:

https://wip.alphaama.com



stable deployment:

https://alphaama.com



image::https://i.nostr.build/XyflANm8pOEQUHI6.jpg["screenshot of alphaama"]



== UI/UX



* alphaama doesn't do much on it's own, it takes commands given by the user and executes them

* it has a single input field for interaction like a Command Line Interface (CLI) wrapped in a Graphical User Interface (GUI) that can be interacted with

* commands are given by prefixing the input with a value (default is ".aa")

* this value also acts as a delimiter for running multiple commands (similar to &&)

* can be used to create any event type and autofills the missing required fields (raw JSON)

* you can use multiple tabs with different requests

* to reset everything, type: `.aa zzz`

* some commands can be repeated using `,` as a separator (ex:`.aa o add trust 4, theme light, pagination 500, ns gm`)

* some commands may be piped using ` | `



== (o) OPTIONS



* to add an option, type: `.aa o add` followed by `key` and `value`

* to delete options, type `.aa o del` followed by `key`, if left empty deletes all and defaults are reset



video::https://v.nostr.build/w5smDlU8vMRQ1r4N.mp4["example of how to switch theme from dark to light and then setting `trust` to `4` so it loads stuff from your fellas:"]



== (r) RELAYS



* relays are kept locally and are separate from your published relays

* relays can be added to sets

* default relay set for reading is "read"

* default relay set for writing is "write"

* default relay set for disabled is "off"

* relay sets (relset) can be used in requests or to create a list (kind:10002)

* depending from where relays were imported, some sets are added automatically (ext, k3, k10002, hint)



to add a relay, type: `.aa r add   `



* `url` is a valid full URL

* `set` is a relay set (a-z_0-9) 

* example command for adding multiple relays: `.aa r add wss://relay1.com read write, wss://relay2.org read, wss://relay3.net write`

* to remove a set from a relay, type: `.aa r setrm  `



== (u) USER



* you can use alphaama without logging in because you can read from Nostr without having to sign anything

* to sign notes, you need a signer already configured with a key (NIP7 enabled browser extension)

* make sure your signer extension is active on the current tab

* you have the option to set a mode on login, either easy or hard

* easy mode adds useful filter queries

* hard mode prevents any external connections



video::https://v.nostr.build/OXw18vj2M8h1Mei0.mp4["example for easy login type: `.aa u login easy`"]



== (q) REQUESTS



to receive events from relays, you send them requests containing filters



* relays will start sending events one by one that match the request filters

* relays will keep relaying new events as they receive them until the request is closed



to send a request, type: `.aa q req  `



* `relset` is either a single relay URL or a relay set id

* `JSON_filter` is a single Nostr request filter in raw JSON

* you can add an extra value in the filter to close the request after all stored events have been sent: `"eose":"close"`



the following variables can be used in filters as values:



* `"n_number"`: converts to a timestamp from `number` of days ago. ex: "n_1" converts to 1 day ago

* `"d_date_string"`: converts to a timestamp of `date_string`. ex: "d_2024-08-21"

* `"now"`: converts to the timestamp of now

* `"u"`: converts to your pubkey (if logged in)

* `"k3"`: converts to a list of pubkeys you follow (if logged in)



you can store requests so it's easier to run them

to store a request, type: `.aa q add  `



* `fid` is a filter identifier with the following allowed characters:  `a-z_0-9`

* `JSON_filter` is explained above



to run a request on specific relays, type: `.aa q run  `



* `fid` is explained above

* `relset` is a single relay url or relay set; by leaving it empty, it defaults to your `read` relay set



to query outbox relays, type: `.aa q out ` 



* `fid` is explained above

* `relset` is a single relay url or relay set; by leaving it empty, it defaults to your `read` relay set



to close a request, type: `.aa q close `



* if `fid` is omitted all opened requests will be closed instead



 

video::https://v.nostr.build/hzQufBzjStD8L8j6.mp4["example of running the request `a`"]



example: `.aa q run f, u, n`



== (p) INTERACTING WITH PUBKEYS 



soon™



the WoT score system used here is very primitive and consists of 2 integer values: 

. a value that you can set manually (default is 0, 9 for the logged-in pubkey and 5 for it's follows) and has influence in displaying content (renders image, video, etc). this value relates to the `trust` option

. a generated value from the number of followers a pubkey has that you also follow. this is only used as a visual hint



== (e) INTERACTING WITH EVENTS 



soon™



== (b) blossom



awesome blossom stuff

blawsome

aws alternative world storage

soon™



== (d) decentipedia 



a decent centipededadedidodude

soon™



== (db) STORED EVENTS 



soon™



== (w) walLNut 



a walLNut is a nip60 enabled cashu wallet

still work in progress, don't be dumb. help yourself



== (?) MAKE YOUR OWN AA MOD 



soon™



== (am) anon & mato 



a game of re_quests. soon™