Git Product home page Git Product logo

receipt's Introduction

Receipt

PDF Receipts generator for any ruby application.

Code Status

Build Status Code Climate

Installation

Add this line to your application's Gemfile:

gem 'receipt'

And then execute:

bundle install

Or install it yourself as:

gem install receipt

Usage

receipt = Receipt::Pdf.new(
  id: 1,
  date: Time.now.to_date,
  amount: '100.00',
  payer: 'Chucky Norris',
  receiver: 'Fernando Almeida',
  description: 'transaction #123',
)

# optional custom content before and/or after the receipt
receipt.before_receipt_box { my_header_content_for(receipt) }
receipt.after_receipt_box { my_footer_content_for(receipt) }

# generate file
File.open(receipt.file)

# send to download
send_data(receipt.data, filename: receipt.filename, type: receipt.mimetype)

Examples

English

Brazilian Portuguese

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bin/console for an interactive prompt that will allow you to use it.

To install this gem onto your local machine, run bundle exec rake install.

To release a new version, update the version number in version.rb, and then run bundle exec rake release to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Maintainer

Fernando Almeida

Contributing

  1. Fork it ( https://github.com/fernandoalmeida/receipt/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Bitdeli Badge

receipt's People

Contributors

fernandoalmeida avatar bitdeli-chef avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.