1
0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2024-11-08 12:12:48 +01:00
invoiceninja/README.md
2017-10-25 21:22:38 +03:00

102 lines
4.7 KiB
Markdown

<p align="center">
<img src="https://raw.githubusercontent.com/hillelcoren/invoice-ninja/master/public/images/round_logo.png" alt="Sublime's custom image"/>
</p>
# Invoice Ninja
[![Build Status](https://travis-ci.org/invoiceninja/invoiceninja.svg?branch=master)](https://travis-ci.org/invoiceninja/invoiceninja)
[![Docs](https://readthedocs.org/projects/invoice-ninja/badge/?version=latest)](http://docs.invoiceninja.com/en/latest/?badge=latest)
[![Join the chat at https://gitter.im/hillelcoren/invoice-ninja](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/hillelcoren/invoice-ninja?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
## [Hosted](https://www.invoiceninja.com) | [Self-Hosted](https://www.invoiceninja.org) | [iPhone](https://itunes.apple.com/WebObjects/MZStore.woa/wa/viewSoftware?id=1220337560&mt=8) | [Android](https://play.google.com/store/apps/details?id=com.invoiceninja.invoiceninja)
All Pro and Enterprise features from the hosted app are included in the open-source code. We offer a $20 per year white-label license to remove our branding for personal use.
The self-host zip includes all third party libraries whereas downloading the code from GitHub requires using Composer to install the dependencies.
## Affiliates Programs
* Referral program (we pay you): $100 per sign up paid over 3 years - [Learn more](https://www.invoiceninja.com/referral-program/)
* White-label reseller (you pay us): $500 sign up fee and either 10% of revenue or $1 per user per month
### Installation Options
* [Self-Host Zip](http://docs.invoiceninja.com/en/latest/install.html)
* [Docker File](https://github.com/invoiceninja/dockerfiles)
* [Softaculous](https://www.softaculous.com/apps/ecommerce/Invoice_Ninja)
## Requirements
* PHP >= 5.5.9
* MySQL
## Recommended Providers
* [Stripe](https://stripe.com/)
* [Postmark](https://postmarkapp.com/)
## Videos
* [Feature Overview](https://www.youtube.com/watch?v=xHGKvadapbA)
* [Getting Started](https://www.youtube.com/watch?v=i7fqfi5HWeo)
* [Time Tracker](https://www.youtube.com/watch?v=hFp5DOkFhTk)
* [Voice Commands](https://www.youtube.com/watch?v=w1ylz-q58cU)
## Features
* Built using Laravel 5.2
* Live PDF generation using [pdfmake](http://pdfmake.org/)
* Supports 50+ payment gateways with [Omnipay](https://github.com/thephpleague/omnipay)
* Integrate with hundreds of apps with [Zapier](https://zapier.com/zapbook/invoice-ninja/) and [Integromat](https://www.integromat.com/en/integrations/invoiceninja)
* Recurring invoices with auto-billing
* Expenses and vendors
* Import bank statements with [OFX](http://www.ofxhome.com/)
* Tasks with time-tracking
* File Attachments
* Multi-user/multi-company support
* Tax rates and payment terms
* Reminder emails
* Partial payments
* Client portal
* Custom email templates
* [D3.js](http://d3js.org/) visualizations
## Documentation
* [User Guide](http://docs.invoiceninja.com/en/latest/)
* [Support Forum](https://www.invoiceninja.com/forums/forum/support/)
* [Feature Roadmap](https://trello.com/b/63BbiVVe/)
## Tools
* [InvoicePlane Import](https://github.com/turbo124/Plane2Ninja)
* [Toggl Sync](https://github.com/Matth--/toggl-invoiceninja-sync)
* [Shopping Cart](https://github.com/Scifabric/invoiceninjashoppingcart)
## Development
* [API Documentation](https://www.invoiceninja.com/api-documentation/)
* [PHP SDK](https://github.com/invoiceninja/sdk-php)
* [Zend Framework](https://github.com/alexz707/InvoiceNinjaModule)
* [Custom Module](http://docs.invoiceninja.com/en/latest/custom_modules.html) | [Watch Video](https://www.youtube.com/watch?v=8jJ-PYuq85k)
## Third Party Developers
* [theDevelopers](https://www.thedevelopers.ro/customisation-request-invoiceninja)
Email us to be added to the list
## Contributing
All contributors are welcome!
For information on how contribute to Invoice Ninja, please see our [contributing guide](CONTRIBUTING.md).
## Credits
* [Hillel Coren](https://hillelcoren.com/)
* [David Bomba](https://github.com/turbo124)
* [All contributors](https://github.com/invoiceninja/invoiceninja/graphs/contributors)
**Special thanks to:**
* [Troels Liebe Bentsen](https://github.com/tlbdk)
* [Jeramy Simpson](https://github.com/JeramyMywork) - [MyWork](https://www.mywork.com.au)
* [Sigitas Limontas](https://lt.linkedin.com/in/sigitaslimontas)
* [Joshua Dwire](https://github.com/joshuadwire) - [Some Techie](https://www.sometechie.com)
* [Holger Lösken](https://github.com/codedge) - [codedge](http://codedge.de)
* [Samuel Laulhau](https://github.com/lalop) - [Lalop](http://lalop.co/)
* [Alexander Zamponi](https://github.com/alexz707)
* [Matthieu Calie](https://github.com/Matth--)
## License
Invoice Ninja is released under the Attribution Assurance License.
See [LICENSE](LICENSE) for details.