Skip to content

How to: submit new app to Hub's Store

Tomek ⚡ K edited this page Jan 5, 2025 · 6 revisions

Alby Hub's App Store is a list of ready-to-use, interesting software and websites that can be connected to your Hub to programmatically use your sats in an easy and controlled way. Thanks to open protocol NWC, Alby Hub can be used by multiple apps and people.

image

Alby Hub is completely open-source. If you want to submit new app to the Hub's Store, please do it directly to its code, becoming our contributor. Please follow steps below:

1. Prepare information about submitted app

id: simplified name of the app, with hyphens instead of spaces, ie: "node-wallet"

title: Name of submitted app, ie: "Node Wallet"

description: One sentence description of the app, max 30 characters

webLink: URL to homepage of the app/project

playLink: Link go Google Play marketplace; optional

appleLink: Link go Apple App Store; optional zapStoreLink: Link to Zap Store; optional guide: Short, step-by-step instructions on how to link submitted app, via NWC connection secret provided by Alby Hub, formatted with HTML

logo: A .png file displaying logo of submitted app; dimensions 200x200; compressed below 2kB; filename "id.png"

This information will be used to render a card like this:

example card

image

Create fork of getalby/hub master branch

Upload the image file to src/assets/suggested-apps/ Edit the /tree/master/frontend/src/components/SuggestedAppData.tsx file

Example final effect:

image

getAlby/hub/tree/master/frontend/src/components/SuggestedAppData.tsx

see example:

image

  1. Add line import damus from "src/assets/suggested-apps/nodewallet.png"; in the front section of SuggestedAppData.tsx

💙 Thank you for your #opensource contribution!

Join Discord server of NWC app developers and users List of all compatible NWC apps Alby Discover - explore the world of Bitcoin Ligthning & Nostr apps

Clone this wiki locally