Every help is welcome, you don't have to be a professional PHP developer or SQL database engineer. If you are not familiar with PHP or coding in general you could also help us in other ways.
We are following some strict development guidelines while developing.
Coding Standard: PSR-2
Use JShint / JSlint to check your JavaScript code and try to resolve all code issues
We use SASS only.
We received some licenses for commercial development tools you can use if you want. Please contact use at [email protected] to get the license / access as we can't publish them here.
- JetBrains PhpStorm (PHP IDE)
- Balsamiq Mockups
- Mailtrap.io eMail Testing Solution
- Before you submit any code to the repository please take a look at the development tracker and search for your issue!
- If an issue exists and someone is working on it, please contact this person.
- If an issue exists and no one is working on it, assign it to yourself or write a comment.
- Always reference the issue ID (e.g. IP-317) in all commits you make for this issue.
- Before you create a pull request, rebase from the development branch.
- Add the development branch as a remote:
git remote add ip [email protected]:InvoicePlane/InvoicePlane.git - Do a rebase with the following command:
git pull --rebase ip developmentWhereipis the name of the remote anddevelopmentthe branch. - Solve all conflicts and check if your code is still working.
- Add the development branch as a remote:
- Submit the pull request, reference the issue ID in the title and add a meaningful description.
Download the following to setup the InvoicePlane VM. Please note: the VM is for development purposes only.
- http://www.ansible.com/home
- https://www.vagrantup.com/
- https://github.com/cogitatio/vagrant-hostsupdater
- https://www.virtualbox.org/wiki/Downloads
- On the virtualbox.org page you will also need to download the appropriate VirtualBox Extension Pack
- Clone the repo to your local machine with
git clone - Run
vagrant upfrom the cloned directory - If provisioning fails just run
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.
Tested with:
$ phpunit -V
PHPUnit 3.7.21 by Sebastian Bergmann.In project root directory run:
$ phpunitPlease ask questions related to this process if you are unclear.
Please notice: 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