Integrazione Ko-fi per Discourse

:information_source: Riepilogo Integra il sistema di donazioni/mance di Ko-fi con Discourse. Ricompensa le donazioni con badge o appartenenza a gruppi.
:hammer_and_wrench: Collegamento al Repository https://github.com/magicball-network/discourse-kofi.git
:open_book: Guida all’Installazione Come installare i plugin in Discourse

Funzionalità

Questo plugin ti consente di collegare il tuo account Ko-fi alla tua comunità Discourse. Gli utenti possono donare denaro tramite Ko-fi, il che può concedere loro ricompense come badge o appartenenza a gruppi. Consente inoltre di associare i livelli di abbonamento di Ko-fi alle appartenenze ai gruppi.

Questo plugin si basa sul webhook di Ko-fi, che invia una notifica a Discourse quando viene ricevuto un pagamento.

Puoi configurare due tipi di ricompense:

  1. Ricompense una tantum come badge e appartenenze a gruppi. Queste ricompense si basano sull’importo totale pagato dagli utenti.
  2. Appartenenze mensili ai gruppi basate sui livelli di abbonamento. Gli utenti rimangono membri del gruppo finché continuano a pagare per quel livello di abbonamento. L’appartenenza al gruppo viene rivalutata dopo un mese.

Oltre a queste ricompense, puoi anche visualizzare una dashboard basata sui pagamenti ricevuti di recente.


Le diverse sezioni della dashboard possono essere abilitate e configurate a tuo piacimento.

Puoi importare l’esportazione CSV di Ko-fi per registrare i pagamenti effettuati prima di installare questo plugin.

Quando vengono ricevuti i pagamenti, il plugin li abbinerà agli utenti in base all’indirizzo email utilizzato per il pagamento Ko-fi e al loro indirizzo email Discourse. Se questi indirizzi non coincidono, un utente può rivendicare i pagamenti effettuati tramite la pagina speciale di Ko-fi nelle preferenze dell’utente. Consente inoltre all’utente di nascondere la propria transazione dalla visualizzazione pubblica.

Configurazione

Devi avere un account Ko-fi funzionante. Dopo aver installato il plugin nel modo consueto, devi configurare il token webhook di Ko-fi nelle impostazioni del plugin e configurare l’URL del webhook per la tua installazione Discourse: https://example.org/ko-fi/webhook

Se hai fatto questo, puoi inviare un messaggio di prova da Ko-fi e controllare la pagina di stato del plugin per verificare che tutto sia a posto.

Potresti voler configurare le ricompense prima di abilitare il webhook o importare un CSV. Altrimenti, dovrai rielaborare le ricompense affinché vengano applicate ai pagamenti attuali.

Impostazioni

Includi una tabella delle impostazioni e delle relative descrizioni

Nome Descrizione
kofi_webhook_token Il token di verifica del webhook. Puoi trovarlo nel tuo account Ko-fi.
kofi_account Il nome del tuo account Ko-fi. Questo verrà utilizzato nella descrizione della dashboard e nel widget Ko-fi, se abilitati.
kofi_dashboard_enabled Abilita la dashboard delle donazioni in Discourse all’indirizzo https://example.org/ko-fi.
kofi_dashboard_in_menu Definisce se aggiungere un elemento di menu “Donazioni” alla dashboard nel menu. Se desideri personalizzare questo elemento di menu, dovresti disabilitare questa opzione.
kofi_dashboard_topic_id L’ID del topic che contiene la descrizione nella dashboard. Un topic con un messaggio predefinito viene creato nella categoria “staff” quando il plugin viene abilitato.
kofi_dashboard_widget_enabled Abilita il widget di donazione Ko-fi sulla dashboard. Questo richiede che kofi_account sia configurato.
kofi_dashboard_count Se maggiore di 0, mostra questo numero di pagamenti recenti.
kofi_dashboard_types I tipi di pagamento Ko-fi da includere nei pagamenti recenti.
kofi_dashboard_anonymous_view Dettagli del pagamento da mostrare nella dashboard per i visitatori non autenticati.
kofi_dashboard_authenticated_view Dettagli da mostrare quando i membri autenticati accedono alla dashboard.
kofi_goal_amount Se maggiore di 0, abilita il widget “obiettivo” sulla dashboard. Questo può essere utilizzato per mostrare i progressi verso un importo target dato.
kofi_goal_period Periodo su cui calcolare l’obiettivo.
kofi_goal_since Se selezioni il periodo “da”, questo sarà il timestamp da cui calcolare i progressi dell’obiettivo.
kofi_goal_show_amount Se abilitato, mostra anche l’importo target sul widget dell’obiettivo. Altrimenti avrai solo una percentuale.
kofi_goal_types Tipi di pagamento Discourse che vengono conteggiati verso l’obiettivo.
kofi_goal_progress_bar_integration Abilita l’integrazione con il Componente Tema Barra di Progresso. Quando i progressi dell’obiettivo vengono calcolati, aggiornerà le impostazioni dei valori corrente e massimo di questo componente.
kofi_leaderboard_count Se maggiore di 0, mostra un widget classifica sulla dashboard.
kofi_leaderboard_days Calcola la classifica in base ai pagamenti degli ultimi giorni.
kofi_leaderboard_types Tipi di pagamento Ko-fi utilizzati per il calcolo della classifica.

Configurazione delle Ricompense

Oltre a queste impostazioni, c’è una scheda Ricompense nelle impostazioni del plugin Ko-fi dove puoi configurare le ricompense una tantum e quelle da abbonamento.

Per le ricompense da abbonamento, devi inserire il nome del livello che hai configurato su Ko-fi. Se cambi mai i nomi dei livelli su Ko-fi, devi aggiornarli anche lì, poiché Ko-fi invierà solo il nome visualizzato e non un ID univoco.

Quando crei o modifichi le ricompense, puoi richiedere che i pagamenti vengano rielaborati in modo che queste ricompense vengano concesse ai pagamenti esistenti.

Amministrazione

Oltre alle schede impostazioni, stato e ricompense, ci sono anche le seguenti schede nella pagina di amministrazione del plugin Ko-fi:

  • Pagamenti – elenco dei pagamenti Ko-fi ricevuti.
  • Account – il collegamento tra i pagamenti Ko-fi e gli utenti.
  • Importa – importa un esportazione CSV dei pagamenti Ko-fi. Usalo per importare i pagamenti già ricevuti.
  • Anonimizza – ti consente di anonimizzare completamente i pagamenti effettuati da un determinato indirizzo email.
2 Mi Piace

Tieni presente che Ko-fi supporta la ricezione di pagamenti in una sola valuta. Per i calcoli, questo plugin considera solo l’importo indicato nelle informazioni di pagamento ricevute, non la valuta. Cambiare la valuta in futuro comprometterà diversi calcoli. Non è prevista alcuna conversione di valuta.

Attualmente mi affido a uno script PHP self-hosted per gestire questa funzionalità sul mio sito.

Utilizzando il tuo plugin, non ne avrò più bisogno. Spero che la mia domanda non sia sgradita, ma ritengo giusto chiedere riguardo ai plugin non ufficiali: è probabile che manterrete questo plugin nel lungo termine? Lo utilizzate voi stessi?

In teoria, avreste qualcosa in contrario a una PR per integrare una barra di avanzamento pubblica (simile al componente del mio tema)?

Da quanto ho capito, la dashboard è accessibile dai membri registrati, ma non esiste un widget da aggiungere altrove?

1 Mi Piace

Utilizzo questo plugin sul mio sito Discourse (ma non tutte le sue funzionalità). Intendo supportare il plugin sia per ESR (che uso) che per l’ultima versione di Discourse. Entrambe queste versioni sono testate nell’ambiente di configurazione del progetto. Questi test vengono eseguiti almeno una volta a settimana se queste versioni cambiano.

Attualmente, solo la parte Ruby del plugin viene testata automaticamente (quasi ogni sua piccola parte). Devo ancora definire come scrivere i test per la parte JavaScript, che intendo fare alla fine.

image

Nessun problema con questo. Accoglierei anche qualsiasi suggerimento per aggiungere punti di estensione (ad esempio, plugin outlet per componenti tema o eventi per plugin).

La dashboard è disponibile per tutti i visitatori.

Non ho creato nulla per aggiungere il widget ko-fi a posizioni arbitrarie. Penso che ciò possa essere fatto tramite componenti tema, proprio come il tuo componente barra di avanzamento. L’impostazione kofi_account è disponibile per il client, il che dovrebbe essere sufficiente per qualsiasi tipo di widget.

1 Mi Piace