tethik/faktura

Simple invoicing webservice using HTML templates.

faktura

Simple invoicing webapplication using HTML templates. The goal of the application is to be an invoice pdf creator, with some minor customer-database features.

Installation

I recommend using a virtualenv. See this guide for a great explanation.

Requirements are collected in the requirements.txt file. pip install -r requirements.txt

You'll also need wkhtmltopdf, which is used by pdfkit. apt-get install wkhtmltopdf or your equivalent packagemanager.

Configuration can be done in the faktura.cfg file, where you can change the sql uri used by sqlalchemy. By default it will use a sqllite database, so you don't have to do anything. Generated pdfs are saved in the pdfs/ folder.

On a server

If you're running this on a VPS, you'll likely need xvfb as a virtual x-server. Check out Server.md for a short how-to install for debian

Demo Usage

To start the http-server as a standalone flask application: python runserver.py

After you've got the application running, simply navigate to http://127.0.0.1:5000

Templating

The PDF is currently created from the render.html template. Change the look of the invoice by editing that document. A proper template editor is a future feature.

Todo

See TODO.md. Ideas at IDEAS.md

Credits

Thanks to the following frameworks and resources:

• Flask
• flask-sqlalchemy
• flask-login
• pdfkit
• skeleton css framework
• flat circle-icons from elegantthemes.com
• http://pixabay.com for cat pictures under creative commons
  • http://pixabay.com/en/cat-animal-cute-pet-feline-kitty-618470/
  • http://pixabay.com/en/cat-animal-snow-188088/
  • http://pixabay.com/en/cat-animal-pet-cats-close-up-300572/

faktura's Issues

Automatically generate a secure SECRET_KEY.

SECRET_KEY is used to encrypt the session cookies. If the default one is used, any sort of login can be easily bypassed by an attacker. The application should perhaps automatically generate this value to something secure during the initial setup to prevent admins from unintentionally forgetting to set this value and using the default value.

The repo should probably not have the config (faktura.cfg) set at all, but instead provide an "example.cfg" to prevent misuse. Optionally add all config options to the first time set up wizard, including the SECRET_KEY.