Contributing to PDFKit

Jump to bottom Edit New page

Amy Unger edited this page Apr 26, 2015 · 5 revisions

First things first

Fork the Repo

Log in or sign up for GitHub
Click the Fork button on the upper right

Get your local development environment set up

Once in the directory on your local machine, you'll want to do some setup.

Like any good gem, PDFKit has a ton of dependencies on other gems. Let's retrieve them by running:
- bundle install
PDFKit relies on a command-line utility, wkHTMLtoPDF, to handle the actual work of converting HTML strings to PDFs. Follow these OS specific instructions to install this dependency.

Begin exploring

Running the tests

Ensure you have everything set up correctly by running the tests.

bundle exec rspec spec/

Command line smoke testing

???