Giter Site home page Giter Site logo

getalby / zapplanner Goto Github PK

View Code? Open in Web Editor NEW
9.0 6.0 6.0 1.7 MB

ZapPlanner - Scheduled recurring lightning payments powered by Nostr Wallet Connect (NWC), enabling lightning subscriptions, bitcoin recurring payments.

Home Page: https://zapplanner.albylabs.com/

TypeScript 93.69% JavaScript 2.76% Dockerfile 2.50% Shell 0.08% CSS 0.97%
bitcoin lightning nostrwalletconnect nwc subscriptions-and-payments

zapplanner's Introduction

ZapPlanner

Scheduled recurring lightning payments powered by Nostr Wallet Connect (NWC)

Try it here: https://zapplanner.albylabs.com/

Programmatically filling the fields

As a service you can programmatically create a URL with all the subscription properties that your users will only need to confirm:

https://zapplanner.albylabs.com/confirm?amount=21&[email protected]&timeframe=30d&comment=baz&payerdata=%7B%22name%22%3A%22Bob%22%7D&returnUrl=https%3A%2F%2Fexample.com
  • amount, recipient, timeframe are required
  • amount is in sats
  • recipient must be a lightning address
  • timeframe must be in milliseconds, or a valid ms string e.g. 1d, 30%20minutes
  • payerdata should be a URL-encoded JSON object as per LUD-18
  • comment and payerdata will only be sent if the recipient lightning address supports it
  • returnUrl encoded URL to show as link on confirmation page

Installation

Run $ yarn install

Run $ cp .env.example .env.local && husky install

note: if .env.local does not work for you, as a temporary solution try renaming it to .env

Run $ yarn cloak:generate and set PRISMA_FIELD_ENCRYPTION_KEY=<CLOAK_MASTER_KEY> in .env.local

Database Setup (Docker)

Run $ yarn docker:start

Run $ yarn db:migrate:deploy

Database Setup (Non-Docker)

Unless you already have it, create the database with: $ createdb boostagram-viewer

Make sure to set your Postgres username and password in .env.local. To list Postgres users, open $ psql followed by > \du. To set no password, leave it empty like this: postgres://username:@localhost....

Run $ yarn db:migrate:deploy

Development (Docker)

Run $ yarn docker:start

Run $ yarn inngest:local

Run $ yarn dev

Development (Non-Docker)

Run $ yarn inngest:local

Run $ yarn dev

NextJS

This is a Next.js project bootstrapped with create-next-app.

Inngest

ZapPlanner is a serverless application that uses Inngest to power its background jobs.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.