discourse-subscriptions/README.md

35 lines
1.2 KiB
Markdown
Raw Normal View History

2017-02-23 20:12:02 -05:00
# Discourse Donations
2017-02-23 20:12:02 -05:00
[![Build Status](https://travis-ci.org/choiceaustralia/discourse-donations.svg?branch=master)](https://travis-ci.org/choiceaustralia/discourse-donations)
2017-02-01 22:57:57 -05:00
2017-02-23 20:12:02 -05:00
Accept donations in Discourse! Integrates with [Stripe](https://stripe.com).
2017-03-05 21:09:28 -05:00
## Installation
* Follow the install instructions here: https://meta.discourse.org/t/install-a-plugin/19157
* Set the private and public keys in the plugin settings.
2017-02-22 23:04:17 -05:00
## Configuration
Visit `/admin/plugins` and configure.
2017-02-22 23:04:17 -05:00
2017-03-13 00:07:51 -04: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-22 23:02:34 -05:00
## Testing
2017-02-06 21:56:22 -05:00
2017-03-01 17:38:33 -05: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 00:56:31 -05:00
2017-02-23 18:28:29 -05:00
**Note:**
2017-02-06 21:56:22 -05:00
2017-02-23 18:28:29 -05: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-12 22:04:29 -04:00
## TODO
2017-03-13 21:37:12 -04:00
* Donate when creating account
2017-03-12 22:04:29 -04:00
* Add a plugin outlet for custom user fields.
* Handle fails from stripe