41 lines
1.6 KiB
Markdown
Raw Normal View History

2017-02-24 12:12:02 +11:00
# Discourse Donations
2017-02-24 12:12:02 +11:00
[![Build Status](https://travis-ci.org/choiceaustralia/discourse-donations.svg?branch=master)](https://travis-ci.org/choiceaustralia/discourse-donations)
2017-02-02 14:57:57 +11:00
2017-05-03 10:25:02 +10:00
Accept donations in Discourse! Integrates with [Stripe](https://stripe.com).
2017-03-31 10:17:13 +11:00
2017-03-06 13:09:28 +11:00
## Installation
2017-05-18 10:14:54 +10:00
* Be sure your site is enforcing https.
2017-03-06 13:09:28 +11:00
* Follow the install instructions here: https://meta.discourse.org/t/install-a-plugin/19157
2017-05-18 10:12:59 +10:00
* Add your Stripe public and private keys in settings and set the currency to your local value.
* Check that the custom header is enabled in admin > customize > themes.
* Enable the plugin and wait for people to donate money.
Note: There's an issue upgrading to 1.8.0.beta11 with themes. You might be required to disable the plugin to do upgrades.
2017-03-06 13:09:28 +11:00
2017-02-23 15:04:17 +11:00
## Configuration
Visit `/admin/plugins` and configure.
2017-02-23 15:04:17 +11:00
2017-03-13 15:07:51 +11:00
## Customisations
Visit `/admin/customize/site_texts` and search for 'discourse_donations'. You'll find a few entries you can customise for your site.
2017-02-23 15:02:34 +11:00
## Testing
2017-02-07 13:56:22 +11:00
2017-03-02 09:38:33 +11:00
* To run the rails specs, install the plugin and run `bundle exec rake plugin:spec[discourse-donations]` in the discourse root directory.
* To run qunit tests: `MODULE='Acceptance: Discourse Donations' bundle exec rake qunit:test[20000]`.
* To run Component tests: `MODULE='component:stripe-card' bundle exec rake qunit:test[20000]`.
2017-02-14 16:56:31 +11:00
2017-02-24 10:28:29 +11:00
**Note:**
2017-02-07 13:56:22 +11:00
2017-02-24 10:28:29 +11:00
* If you're using a zsh shell, then you probably get this error: `zsh: no matches found ...` and you'll need to escape the square brackets with backslashes.
2017-03-13 13:04:29 +11:00
## TODO
2017-03-14 12:37:12 +11:00
* Donate when creating account
2017-03-13 13:04:29 +11:00
* Add a plugin outlet for custom user fields.
* Handle fails from stripe