0.02
No commit activity in last 3 years
No release in over 3 years
stripe_invoice adds PDF views and automated emails to your Koudoku-based application
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Project Readme

StripeInvoice

StripeInvoice makes it easy for you to show invoices/receipts to the customers of your Koudoku-based Rails application. It downloads the last 100 invoices via the Stripe API, stores them in a table in the database and renders a basic invoice template.

Features

  • Show invoices & receipts to your customers
  • Automatically assign Invoice # for new invoices
  • Download invoices as PDF

Requirements

StripeInvoice is opinionated on which gems your application uses.

  1. Koudoku to handle subscriptions
  2. Devise for user authentication

Usage

Installation

StripeInvoice is hosted on RubyGems.org. To use it, just add the following line to your Gemfile and run bundle install:

gem 'stripe_invoice'

To setup your application run the following commands from the command line:

rails generate stripe_invoice:install
rake db:migrate

This will add necessary migrations to your application and run them. Additionally it will mount StripeInvoice into your application at /stripe_invoice

Accessing the invoices

To view the invoices log into your application and go to /stripe_invoice/

Customizing the views

You probably want to customize the views for your application. You can easily install the views files (written with HAML) to your application by running rails g stripe_invoice:views from the command line. The views will be installed into app/views/stripe_invoice/invoices/ folder

Contribution

To contribute to the development of StripeInvoice please:

  1. fork the repository
  2. create a development branch
  3. code away
  4. send a pull request

Developer

This plugin is under development by Christoph Engelhardt, author of SaaS Email Marketing Handbook