Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/begriffs/lucre

Let people pay you for any or no reason.
https://github.com/begriffs/lucre

Last synced: about 1 month ago
JSON representation

Let people pay you for any or no reason.

Host: GitHub
URL: https://github.com/begriffs/lucre
Owner: begriffs
License: mit
Created: 2013-04-14T03:28:58.000Z (over 11 years ago)
Default Branch: master
Last Pushed: 2016-12-16T05:38:54.000Z (almost 8 years ago)
Last Synced: 2024-06-03T22:52:30.992Z (4 months ago)
Language: Ruby
Size: 47.9 KB
Stars: 504
Watchers: 23
Forks: 55
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

starred-awesome - lucre - Let people pay you for any or no reason. (Ruby)

README

# What's the fuss? Let them pay you!

How come only stores accept debit/credit cards? You should be able
to accept them too. Let your friends send you some money, or charge
for impromptu consulting. Just deploy this app to Heroku, change some
variables and you're in business.

This thing doesn't ask the customer much, just for an email
and the payment amount. All the credit card info stays on
[Stripe](https://stripe.com) so you have nothing to worry about.

You can see it in action [here](http://pay.begriffs.com). If you like
it, why not donate? ;)

## Installation

1. Get a [Stripe](https://stripe.com) account and find your API keys.
1. Fork and clone this repo.
1. Get a [Heroku](http://heroku.com) account.
1. Deploy this app to a new Heroku instance.
1. Set the environment variables (see below).
1. Profit? Quite possibly.

For each variable below, set its value in your heroku instance by
running `$ heroku config:add VARIABLE_NAME=value`.

Value
Variable Name
Example

Your Name
PAYEE_NAME
John Doe

Your Twitter Handle
PAYEE_TWITTER
jdoe

Shorthand url of your site
PAYEE_SITE
jdoe.com

Full URL of your site
PAYEE_SITE_URL
http://jdoe.com

Stripe public key
STRIPE_PUBLISHABLE_KEY
pk_xyz

Stripe private key
STRIPE_SECRET_KEY
sk_abc

## Requesting Payment?

If you are using lucre to collect an owed debt you can create a
customized link to your lucre installation with a specified email and/or
amount you intend to collect.

```
http://your-lucre-site.com/[email protected]
```

The above will fill-in the email address of the person from whom you are
collecting monies.

```
http://your-lucre-site.com/[email protected]&amount=47.39
```

The above will fill-in your client's email address and amount to be
collected, in this case $47.39.

## Contributing

To run this project locally in development, copy the `.env.example` to
`.env` and fill in the blanks. It contains the environment variables
described in the table above. The app does not require setting up a
database.

Use the stripe test credentials provided in your account to use fake
cards without issuing real charges. There are a variety of [test card
numbers](https://stripe.com/docs/testing#cards) to simulate any kind of
error or card event.

## License