If you want to help developing InvoicePlane you need to prepare InvoicePlane for working with it as huge parts of the application are missing in the source code and need to be downloaded and compiled.
If you have any questions, feel free to join the
#development channel in our Slack Chat.
Please read the Contribution Guide before starting to work on the app.
The following tasks need to be accomplished before starting to work on and with InvoicePlane:
grunt-clipackage is installed globally via NPM
The following steps are required to make InvoicePlane runnable:
ipconfig.php.examplefile and rename the copy to
Then point your webserver to the InvoicePlane directory. That's it.
Download the following to setup the InvoicePlane VM. Please note: the VM is for development purposes only.
vagrant upfrom the cloned directory
vagrant provisionfrom the terminal
You should be able to navigate to your local though by doing www.invoiceplane.local
On the setup screen specify localhost, root, blank password, invoiceplane as the database configuration.
Note: When the VM is booted you can change the
php.ini file to setup xdebug or other preferences.
Ask questions! Please ask questions related to this process if you are unclear.
The name 'InvoicePlane' and the InvoicePlane logo are both copyright by Kovah.de and InvoicePlane.com and their usage is restricted! For more information visit invoiceplane.com/license-copyright