-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.txt
125 lines (99 loc) · 7.22 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
=== Buy Me a Coffee button & widgets - Fundraise with Stripe and PayPal ===
Contributors: wpminers, hasanuzzamanshamim
Tags: buy me a coffee, donations, payments, stripe payments, fundraise
Requires at least: 4.5
Tested up to: 6.6.1
Stable tag: 1.0.3
Requires PHP: 7.4
License: GPLv2 or later
Text Domain: buy-me-coffee
Easy way to collect donations like "buy me a coffee" directly your own Stripe and PayPal for free.
== Description ==
[User Guide](https://wpminers.com/buymecoffee/docs/getting-started/quick-setup/) | [Demo](https://wpminers.com/buymecoffee-demo)
Stripe onsite and PayPal pro module allow you to get paid right on your site. Buy Me a Coffee offers you different templates like donate a coffee or donate a custom amount.
[youtube https://www.youtube.com/watch?v=m3T5LQ1DOEc&ab_channel=WPMiners]
**Buy me a Coffee** is a free WordPress plugin that allows you to accept donations from your visitors. It is a simple and effective way to monetize your content. You can accept donations via PayPal or Stripe. The plugin is very easy to use and configure. You can add a PayPal donation button, Form, or template anywhere on your website using a shortcode or a widget.
**Buy Me a Coffee** is a perfect solution for content creators, bloggers, musicians, artists, developers, gamers, photographers, and all other types of content creators who want to accept donations (as Buy Coffee for Me) from their visitors.
You can use it for free without any limitations. You can accept donations from your visitors without any commission.
Donations are collected directly into your own PayPal or Stripe account merchant. You can accept donations in any currency supported by PayPal or Stripe.
one-time donations are available now will implement recurring donations in the future.
You can accept donations from your visitors using a Stripe and PayPal donation button, Form, or template. Accept donations from your visitors using a shortcode or a widget.
It Will be available using a popup or a page.
You can accept donations from your visitors using custom amounts.
Features:
Custom number of donations
Accept donations using Onsite Stripe and PayPal Pro
Customizable templates
Form shortcode and widget
Buttons Shortcode and widget
Donor profiles
Donation statistics/reports
Quick setup mode
Buy Me a Coffee counter
Multiple theme templates
## Installation
1. Download a release version and Upload the plugin files to the `/wp-content/plugins/buy-me-coffee` directory, or install the plugin through the WordPress plugins screen directly.
2. Activate the plugin through the 'Plugins' screen in WordPress
3. Use the Dashboard -> Quick setup screen to configure basic settings
## Frequently Asked Questions
#### How to use the plugin?
You can use the plugin for free without any limitations. You can accept donations from your visitors without any commission.
Donations are collected directly into your own PayPal or Stripe account merchant. You can accept donations in any currency supported by PayPal or Stripe.
#### How to accept donations?
You can accept coffee donation or custom amount donations by stripe pro, Also PayPal pro or PayPal standard from the next version.
#### Do you have a premium version?
No, we don't have a premium version. You can use the plugin for free without any limitations.
#### Do you have a recurring donation?
No, we don't have a recurring donation. We will implement recurring donations in the future.
#### Do I need coding skills to use the plugin?
No, you don't need coding skills to use the plugin. You can use the plugin without any coding skills.
#### Do you have documentation?
Yes, you can find the documentation on the [Buy me a coffee](https://wpminers.com/buymecoffee/docs/getting-started/quick-setup/) website.
though the plugin is very simple and easy to use so you don't need any documentation.
#### Is it secure?
Yes, it is secure. We don't store any data on our servers. All data is stored on your own PayPal or Stripe account.
## Screenshots
1. Admin Dashboard
2. Global Settings
3. Guided Quick setup
4. Buy me a coffee Preview
5. Stripe Payment settings
## Changelog
= 1.0.3 August 26, 2024=
- Fixes styling issue
- Fixes customizer module issue
- Fixes checkout button issue
= 1.0.2 March 10, 2024=
- Adds Realtime theme customizer
= 1.0.1 March 7, 2024=
- Adds PayPal Pro Payment Gateway
= 1.0.0 March 3, 2024=
- Initial release
# Development Docs
#### CDN used for Payments:
* [Stripe SDK](https://js.stripe.com/v3/)
is used to create a Stripe payment button and collect donations from your visitors. It is required to create a Stripe payment element. There is a clear documentation on Stripe's website link above about how Stripe manage user data.
* [PayPal SDK](https://developer.paypal.com/sdk/js/reference/)
is used to create a PayPal donation button and collect donations from your visitors. It is required to create a PayPal donation button. There is a clear documentation on PayPal's website link above about how PayPal manage user data.
#### 3rd Party services:
* [Stripe](https://www.stripe.com)
is used to collect payments from users. where the sdk client library is used. [Stripe SDK](https://js.stripe.com/v3/)
We use [stripe api] (https://api.stripe.com/v1/) to authenticate and process payment through stripe. We won't store any card info
or other private data. Only required things are stored like a Stripe Public key, Secret key.
you may check the full privacy policy from here,
[Stripe privacy policy] (https://stripe.com/privacy)
* [PayPal](https://www.paypal.com/)
is used to collect donations from your visitors. It is required to create a PayPal donation button. There is a clear documentation on PayPal's website link above about how PayPal manage user data.
for PayPal sandbox you may use [PayPal Sandbox](https://developer.paypal.com/docs/api-basics/sandbox/accounts/).
For PayPal IPN BuyMeCoffee plugin use PayPal IPN to verify the payment.
And for library SDK [PayPal SDK](https://www.paypal.com/sdk/js?client-id=) where it requires your clientId.
To verify the PayPal payment Buy Me A Coffee used ipn [Live API 1](https://ipnpb.paypal.com/cgi-bin/webscr), [Live APi 2](https://ipnpb.paypal.com/cgi-bin/webscr)
and [Test API 1](https://ipnpb.sandbox.paypal.com/cgi-bin/webscr), [Test API 2](www.sandbox.paypal.com/cgi-bin/webscr)
#### PHP library used:
* [WP Fluent DB library](https://github.com/hasanuzzamanbe/wp-fluent/)
This is just a Database library for WordPress. It is not a full-fledged ORM. It is a simple database library that makes working with the database easier. It is inspired by Laravel's Eloquent ORM. It's not collect any data from your site.
#### NPM Package used:
[element-plus/icons-vue](https://www.npmjs.com/package/@element-plus/icons-vue),[element-plus](https://www.npmjs.com/package/element-plus/),[@wordpress/hooks](https://www.npmjs.com/package/@wordpress/hooks),[chart.js](https://www.npmjs.com/package/chart.js),[clipboard](https://www.npmjs.com/package/clipboard),[lodash](https://www.npmjs.com/package/lodash),[vue](https://www.npmjs.com/package/vue),[vue-router](https://www.npmjs.com/package/vue-router)
#### Contribution guideline:
Go to [GitHub Repo](https://github.com/hasanuzzamanbe/buy-me-coffee) to see package.json for the full list of scripts and packages used in this project.
Follow the guidelines available in readme.