discourse-subscriptions/README.md

# Discourse Donations

[![Build Status](https://travis-ci.org/choiceaustralia/discourse-donations.svg?branch=master)](https://travis-ci.org/choiceaustralia/discourse-donations)

Accept donations in Discourse! Integrates with [Stripe](https://stripe.com).

## 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.

## Configuration

Visit `/admin/plugins` and configure your private and public keys.

## TODO

* Add a plugin outlet for custom user fields.
* Some tests
* Handle fails from stripe
* Add currency and postcode to settings

## Testing

* 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]`.

**Note:**

* [This fix](https://github.com/discourse/discourse/pull/4719) is required to run qunit test modules.
* 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.
* [This fix](https://github.com/discourse/discourse/pull/4738) renders the extra nav items consistently.
update readme with new name yo 2017-02-23 20:12:02 -05:00			`# Discourse Donations`
Transaction works. Still need to tidy up response 2017-02-01 19:49:22 -05:00
update readme with new name yo 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)`
enable travis 2017-02-01 22:57:57 -05:00
update readme with new name yo 2017-02-23 20:12:02 -05:00			`Accept donations in Discourse! Integrates with [Stripe](https://stripe.com).`
Transaction works. Still need to tidy up response 2017-02-01 19:49:22 -05:00
install instructions 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.`

Update README.md 2017-02-22 23:04:17 -05:00			`## Configuration`

remove settings yaml config 2017-02-27 21:23:23 -05:00			Visit `/admin/plugins` and configure your private and public keys.
Update README.md 2017-02-22 23:04:17 -05:00
Update README.md 2017-02-22 23:02:34 -05:00			`## TODO`

			`* Add a plugin outlet for custom user fields.`
			`* Some tests`
			`* Handle fails from stripe`
document todo 2017-03-06 20:16:39 -05:00			`* Add currency and postcode to settings`
Update README.md 2017-02-22 23:02:34 -05:00
			`## Testing`
inital empty page 2017-02-06 21:56:22 -05:00
document running it in the readme 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]`.
Update README.md 2017-02-14 00:56:31 -05:00
document test runner 2017-02-23 18:28:29 -05:00			`Note:`
inital empty page 2017-02-06 21:56:22 -05:00
document test runner 2017-02-23 18:28:29 -05:00			`* [This fix](https://github.com/discourse/discourse/pull/4719) is required to run qunit test modules.`
			* 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.
add an extra nav item 2017-03-05 22:44:11 -05:00			`* [This fix](https://github.com/discourse/discourse/pull/4738) renders the extra nav items consistently.`