tobystokes / invoice-devkit

The development files to help you customise your invoice theme

Home Page:http://www.freeagent.com/support/kb/invoicing/invoice-devkit/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

FreeAgent Invoice Devkit

The development files to help you customise your invoice theme. Maintained by the FreeAgent development team.

The full guide to creating a custom invoice theme can be found here:
http://www.freeagent.com/support/kb/invoicing/css-guide-for-invoice-templates/

Getting started

Download the devkit, then run a local server at the root directory. You may already have your own methods for running a local server. If not, here are a few options for starting one from the command line:

php -S localhost:3000 to run PHP (>= 5.4.0)
python -m SimpleHTTPServer 3000 for Python 2.7
ruby -run -e httpd . -p 3000 for Ruby

You could also download an app like MAMP or XAMPP.

Running a local server ensures the relevant background paths in the theme CSS files stay consistent with the invoice theme code we use in the FreeAgent app, making it easy for you to copy/paste your changes (and yes, this is why the directory structure seems a bit strange).

Edit your CSS

Duplicate both screen and print CSS files for whatever theme you want to base yours on and rename them (or simply create your own from scratch, but be aware this will be much harder). Now change the stylesheet paths in index.html to reference your new stylesheets.

Make all of the changes to your theme CSS. Remember that your invoice has to render well as a PDF in addition to the on-screen preview. Theme layouts also change depending on what state they’re in (e.g. a draft invoice has additional elements like the "Add Invoice Item" button), and when other company-type content is present (e.g. a sales tax column).

When you’re happy with your changes and want to test them, paste your CSS into the custom theme area of your FreeAgent account. Our guide to creating custom invoice themes article contains further detail on this.

Remember it’s not possible to edit the underlying HTML of invoice in FreeAgent. The markup in index.html is purely for reference. When you go to use your custom theme, the only code you’ll be able to paste into FreeAgent will be CSS.

Files and directories

index.html
An example file showing a preview of what your invoice theme will look like. Don’t bother editing any of the HTML, as you can’t edit the HTML for invoices in FreeAgent. Only the CSS can be edited, so the only change you’ll want to make in this file is to amend the stylesheet hrefs.

base.css
Do not edit. These are base styles used to simulate those from the FreeAgent desktop environment.

gallery, images, and themes
Do not edit. These directories contain imagery referenced by our own invoice themes.

styles
Contains copies of our invoice theme stylesheets. You can use these as the basis for your own theme, but we’d recommend creating duplicates of the files you want, then renaming them. This way you’ll always have the original theme files to compare against your own, in case you need to fix something that’s gone wrong with your custom theme.

About

The development files to help you customise your invoice theme

http://www.freeagent.com/support/kb/invoicing/invoice-devkit/


Languages

Language:CSS 89.6%Language:HTML 10.4%