https://github.com/neilck/nostr-badges

Nostr Badge microservice for self-awarded badges.
https://github.com/neilck/nostr-badges

badges decentralized identity nip-58 nostr

Last synced: about 1 month ago
JSON representation

Nostr Badge microservice for self-awarded badges.

• Host: GitHub
• URL: https://github.com/neilck/nostr-badges
• Owner: neilck
• Created: 2024-02-05T17:02:14.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-05-28T16:46:49.000Z (7 months ago)
• Last Synced: 2024-05-29T01:10:40.713Z (7 months ago)
• Topics: badges, decentralized, identity, nip-58, nostr
• Language: TypeScript
• Homepage: https://app.akaprofiles.com
• Size: 2.48 MB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-nostr - nostr-badges - badges.svg?style=social) - Nostr badge microservice for managing self-awarded badges. Live at [app.akaprofiles.com](https://app.akaprofiles.com) (Tools / Client reviews and/or comparisons)

README

        
### Disambiguation

Looking for the [AKA Profiles Chrome Extension](https://github.com/neilck/aka-extension)?

## nostr-badges

AKA Profiles is a microservice/app for Nostr badges that can be integrated into any Nostr client.

Your client can provide exclusive access to content or features based on a user's Nostr badges, redirecting users to AKA Profiles to obtain the necessary badges if not yet awarded.







### User Flow

After redirection, AKA Profiles:

1. displays the list of required badges

2. directs the user to the associated badge award web pages

3. records a badge award approvals from each apply web page

4. redirects the user back to the client once all the badges are awarded

_The user flow is similar to OAuth, where the user is directed between different pages via redirects or dialogs._

## Badge Library

The badge library is at the heart of AKA Profiles, enabling badges to be reused as eligibility criteria by multiple clients.

- Select your required badges from the existing badges in the library

- Add your badge to the library for use by your client and other clients

For example, your client could require that a user has the "Not a Robot" badge from the library before they are allowed to post. This badge's `apply web page` requires a user to patch a Captcha.

If none of the library badges meet your needs, you can add your own badge into the library and share it with other clients.

## Latest Changes

### Version 0.2.0

Replaced `verifySession` and `getConfig` endpoints with JWT.

- iframed award badge URLs get `code` 

- award badge pages exchange `code` for web token

- successfully decoding of web token replaces `verifySession`

- inclusion of badge configuration parameters in token replaces `getConfig`

- call to `awardBadge` authorized by token instead of AKA_API_KEY

## Learn more

Still in development. 

Live at [AKA Profiles App](https://app.akaprofiles.com)

See [AKA Profiles Documentation](https://www.akaprofiles.com)