Skip to content

Latest commit

 

History

History
60 lines (51 loc) · 5.44 KB

README.md

File metadata and controls

60 lines (51 loc) · 5.44 KB
Raw

Booking system for any type of service that requires a calendar, from an online class to a room reservation.
For bitcoiners, KYC free, self custodial.
The client can pay in bitcoin, crypto and fiat and the merchant always receives bitcoin.
Without KYC requirements for the merchant and the client. Merchant and buyer personal information are never shared with the counterparty.
Demo

Status

Under active development.

  • Profile and services settings. Ready.
  • Btcpay server api integration. Ready.
  • Bitcoin checkout. On-chain and Lighning Network. Ready.
  • Fiat integration with Peach Bitcoin api. Under current development.
  • Crypto integration with SideShift api. Planned.
  • Merchant control panel. Planned.
  • Calendar integration. Planned, with google calendar or better with a privacy focused calendar app that provides api.

Features

  • Self custodial solution with btcpay server integration.
  • Supports on-chain and Lighning Network payments.
  • Optionally supports shitcoins (altcoins and fiat) with the merchant always receiving bitcoins.
  • Unlimited services and unlimited extras for each service.
  • Supports any service duration, from 1 minutes to multiple days.
  • Multilingual: English, Spanish and Italian out of the box with the easy option to add additional translations.
  • Static generate pages without cookies.
  • Technical SEO opimized and 98/100 Google Lighhouse performance score.

Target

  • Bitcoin enthusiasts: you believe in Bitcoin sound money but at the same time you know that Bitcoin is not widely used as you wish. This tool allows you to reach the traditional market without touching shitcoins.
  • High risk businesses: you are involved in legal high risk business such as adult or cannabis consultancy and you can't find a traditional payment gateway supporting your business.
  • Unbanked and sanctioned: you are unbanked, or you live in a country that has not easy access to popular payment processors like Stripe, because your country is unsupported or even sanctioned.
  • Emerging markets: you want to expand your virtual service business to emerging markets like LATAM and Africa and you lack of a reliable payment gateway.

Payment methods. Fees. Limits.

  • Bitcoin: onchain and lightning network, no fee. No amount limit.
  • Crypto: all the currencies supported by SideShift. Fee between 0.5% and 1% paid by the buyer. No amount limit.
  • Fiat: All the currencies and local payment methods supported by Peach Bitcoin as listed here. Tens of local payment methods in Europe, LATAM, Africa with more to come, US excluded. The fee is set by the merchant and paid by the buyer. realistically, to find a match it should be between 5 and 10%, plus 2% Peach fee. 1000 CHF (or equivalent in other currency) amount limit for each payment.

Setup

  1. Clone the repo.
  2. Edit the repo configuration in ./content/settings.yaml accordingly to your needs. The file is commented to explain each setting meaning.
  3. Create a profile.md file inside each ./content folder and the language subfolder. Check this file comments for available settings. This is optional. If you want to skip the profile and offer just one service, you can set the DEFAULT_SERVICE env variable to the service file name.
  4. Create one file for each service inside each ./content folder and the language subfolder. Check this file comments for available settings. Optionally, if you want to show the services in a specific order, add the order number at the beginning of the name followed by a dot, eg 1.my-service.md
  5. Set the enviroment variables as in the ./.env.example file.
  6. Optionally set a custom color in the first line of ./assets/scss/custom.scss.
  7. Optionally add or remove languages support by adding/removing translations in ./lang folder and settings in ./assets/js/locale.js locales json object.
  8. Deploy (Digital Ocean app platform is supported out of the box, Vercel is supported with a few settings change that I will document soon, Self hosting is supported if you know how to build and deploy a Nuxt application).

BTCPay instance

If you don't have a btcpay instance, feel free to email me optionally with PGP and I will invite you to create an account/store on my btcpay server.

Contribution

The most valuable contributions at the moment are:

  • Bug report: test the software and report bugs using github issues.
  • Feedbacks: let me know what would you would like to see implemeneted using github issue.

Commits to the code are appreciated. Please sign your commit.

Project inspired by BitPagos and LNCal.