discourse-subscriptions/README.md

43 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-02-22 23:04:17 -05:00
## Configuration
You can either set your environment vars in docker or save them in a yaml.
In your `app.yml`:
```
STRIPE_SECRET_KEY: 'sk_test_key'
STRIPE_PUBLISHABLE_KEY: 'pk_test_key'
```
2017-02-22 23:02:34 -05:00
## TODO
* Remove hard coded key and use settings.
* Add a plugin outlet for custom user fields.
* Some tests
* Handle fails from stripe
* A button in the user's profile page.
2017-02-13 21:57:23 -05:00
**In your app.yml**
2017-02-13 21:57:37 -05:00
```
2017-02-13 21:57:23 -05:00
STRIPE_SECRET_KEY: 'my_secret_key'
STRIPE_PUBLISHABLE_KEY: 'my_publishable_key'
2017-02-13 21:57:37 -05:00
```
2017-02-13 21:57:23 -05:00
2017-02-22 23:02:34 -05:00
## Testing
2017-02-06 21:56:22 -05:00
2017-02-23 20:42:59 -05:00
To run the rails specs, install the plugin and run `bundle exec rake plugin:spec[discourse-donations]` in the discourse root directory.
2017-02-14 18:59:04 -05:00
2017-02-23 20:51:26 -05:00
To run qunit tests: `MODULE='Acceptance: Discourse Donations' 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
* [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.