1
0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2024-11-15 07:33:04 +01:00
invoiceninja/README.md

87 lines
4.2 KiB
Markdown
Raw Normal View History

2015-09-17 22:28:54 +02:00
<p align="center">
2016-08-15 05:39:15 +02:00
<img src="https://raw.githubusercontent.com/hillelcoren/invoice-ninja/master/public/images/round_logo.png" alt="Sublime's custom image"/>
2015-09-17 22:28:54 +02:00
</p>
2015-09-17 22:26:57 +02:00
# Invoice Ninja
2015-03-18 15:34:33 +01:00
2017-03-09 20:27:15 +01:00
[![Build Status](https://travis-ci.org/invoiceninja/invoiceninja.svg?branch=master)](https://travis-ci.org/invoiceninja/invoiceninja)
2017-01-01 19:26:32 +01:00
[![Docs](https://readthedocs.org/projects/invoice-ninja/badge/?version=latest)](http://docs.invoiceninja.com/en/latest/?badge=latest)
2016-08-30 15:56:46 +02:00
[![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)
2017-03-22 20:41:01 +01:00
## [Hosted](https://www.invoiceninja.com) | [Self-hosted](https://www.invoiceninja.org) | [iPhone](https://itunes.apple.com/WebObjects/MZStore.woa/wa/viewSoftware?id=1072566815&mt=8) | [Android](https://play.google.com/store/apps/details?id=com.invoiceninja.invoiceninja)
2016-05-17 22:45:00 +02:00
2016-12-21 16:44:30 +01:00
Watch this [YouTube Video](https://www.youtube.com/watch?v=xHGKvadapbA) for an overview of the app's features.
2017-01-22 11:09:29 +01:00
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.
2016-09-06 09:27:46 +02:00
2016-12-21 16:18:05 +01:00
The [self-host zip](https://www.invoiceninja.com/self-host/) includes all third party libraries whereas downloading the code from GitHub requires using Composer to install the dependencies.
2016-09-12 07:56:53 +02:00
## Affiliates Programs
2016-02-22 14:17:28 +01:00
* Referral program (we pay you): $100 per signup paid over 3 years - [Learn more](https://www.invoiceninja.com/referral-program/)
* White-label reseller (you pay us): 10% of revenue with a $500 sign up fee
2015-11-24 20:45:13 +01:00
### Installation Options
2015-10-23 08:36:07 +02:00
* [Self-Host Zip](https://www.invoiceninja.com/knowledgebase/self-host/) - Free
* [Docker File](https://github.com/invoiceninja/dockerfiles) - Free
2015-10-23 08:36:07 +02:00
* [Softaculous](https://www.softaculous.com/apps/ecommerce/Invoice_Ninja) - $30
2015-04-30 19:54:19 +02:00
## Requirements
2016-03-01 20:46:47 +01:00
2016-02-27 21:12:22 +01:00
* PHP >= 5.5.9
2015-11-24 20:52:48 +01:00
* MySQL
## Recommended Providers
2016-09-05 20:34:47 +02:00
* [WePay](https://www.invoiceninja.com/wepay-accept-online-payments-instantly/)
2016-02-22 14:17:28 +01:00
* [Stripe](https://stripe.com/)
* [Postmark](https://postmarkapp.com/)
2016-12-21 16:39:01 +01:00
## Features
2016-03-02 14:43:09 +01:00
* Built using Laravel 5.2
2015-09-02 12:59:03 +02:00
* Live PDF generation using [pdfmake](http://pdfmake.org/)
2016-11-07 16:42:54 +01:00
* Supports 50+ payment gateways with [Omnipay](https://github.com/thephpleague/omnipay)
* Integrate with hundreds of apps with [Zapier](https://zapier.com/zapbook/invoice-ninja/)
* Recurring invoices with auto-billing
2016-02-14 20:44:49 +01:00
* Expenses and vendors
2016-09-06 09:20:51 +02:00
* Import bank statements with [OFX](http://www.ofxhome.com/)
2015-05-31 14:37:29 +02:00
* Tasks with time-tracking
2016-05-10 21:51:17 +02:00
* File Attachments
2015-09-02 12:59:03 +02:00
* Multi-user/multi-company support
2015-05-31 14:37:29 +02:00
* Tax rates and payment terms
2015-09-17 22:26:57 +02:00
* Reminder emails
2015-05-09 20:25:16 +02:00
* Partial payments
2015-10-14 22:56:17 +02:00
* Client portal
2015-05-09 20:25:16 +02:00
* Custom email templates
* [D3.js](http://d3js.org/) visualizations
## Documentation
2016-11-13 22:47:51 +01:00
* [Self Host Guide](https://www.invoiceninja.com/self-host)
2016-08-30 15:01:37 +02:00
* [User Guide](http://docs.invoiceninja.com/en/latest/)
2015-03-23 13:13:13 +01:00
* [Developer Guide](https://www.invoiceninja.com/knowledgebase/developer-guide/)
2015-10-07 21:24:37 +02:00
* [Support Forum](https://www.invoiceninja.com/forums/forum/support/)
* [Feature Roadmap](https://trello.com/b/63BbiVVe/)
2016-12-08 08:57:13 +01:00
## Development
* [API Documentation](https://www.invoiceninja.com/api-documentation/)
2017-02-14 11:37:10 +01:00
* [PHP SDK](https://github.com/invoiceninja/sdk-php)
* [Custom Module](http://docs.invoiceninja.com/en/latest/custom_modules.html) | [Watch Video](https://www.youtube.com/watch?v=8jJ-PYuq85k)
2016-11-13 22:47:51 +01:00
## Contributing
All contributors are welcome!
For information on how contribute to Invoice Ninja, please see our [contributing guide](CONTRIBUTING.md).
## Credits
2017-04-02 23:41:48 +02:00
* [Hillel Coren](https://hillelcoren.com/)
* [All contributors](https://github.com/invoiceninja/invoiceninja/graphs/contributors)
2016-02-14 22:19:23 +01:00
**Special thanks to:**
2015-10-07 21:25:35 +02:00
* [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)
2015-12-31 05:47:09 +01:00
* [Joshua Dwire](https://github.com/joshuadwire) - [Some Techie](https://www.sometechie.com)
2016-08-22 11:47:41 +02:00
* [Holger Lösken](https://github.com/codedge) - [codedge](http://codedge.de)
* [Samuel Laulhau](https://github.com/lalop) - [Lalop](http://lalop.co/)
2015-10-07 21:25:35 +02:00
## License
Invoice Ninja is released under the Attribution Assurance License.
2016-08-02 11:52:18 +02:00
See [LICENSE](LICENSE) for details.