1
0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2024-11-08 12:12:48 +01:00
invoiceninja/README.md

99 lines
5.1 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-12-01 13:32:59 +01:00
[![Build Status](https://travis-ci.org/invoiceninja/invoiceninja.svg?branch=master)](https://travis-ci.org/invoiceninja/invoiceninja)
2018-07-26 17:41:30 +02:00
[![Docs](https://readthedocs.org/projects/invoice-ninja/badge/?version=latest)](https://invoice-ninja.readthedocs.io/en/latest/?badge=latest)
2018-06-10 08:24:39 +02:00
## [Hosted](https://www.invoiceninja.com) | [Self-Hosted](https://www.invoiceninja.org)
2016-05-17 22:45:00 +02:00
2020-05-18 15:23:06 +02:00
### We're on Slack, join us at [slack.invoiceninja.com](http://slack.invoiceninja.com) or if you like [StackOverflow](https://stackoverflow.com/tags/invoice-ninja/)
2020-11-01 16:34:29 +01:00
2020-05-18 15:01:00 +02:00
Just make sure to add the `invoice-ninja` tag to your question.
2021-03-19 23:02:13 +01:00
#### Note: v5 is now tagged Stable! To upgrade from v4 you need to [install v5](https://invoiceninja.github.io/docs/self-host-installation/) as a separate app and then use the migration tool in the latest version of v4 on Settings > Account Management.
2020-04-14 16:18:02 +02:00
2021-06-15 15:47:05 +02:00
All Pro and Enterprise features from the hosted app are included in the open-code. We offer a $30 per year white-label license to remove the Invoice Ninja branding from client facing parts of the app.
2016-09-06 09:27:46 +02:00
2017-07-02 15:27:39 +02:00
The self-host zip 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
2017-12-01 11:44:05 +01:00
* [Features](https://www.invoiceninja.com/invoicing-features/)
* [Videos](https://www.youtube.com/channel/UCXAHcBvhW05PDtWYIq7WDFA/videos)
2020-05-18 15:01:00 +02:00
* [User Guide](https://docs.invoiceninja.com/)
2017-12-01 11:44:05 +01:00
* [Support Forum](https://www.invoiceninja.com/forums/forum/support/)
2020-05-18 15:01:00 +02:00
* [StackOverflow](https://stackoverflow.com/tags/invoice-ninja/)
2017-12-01 11:44:05 +01:00
2019-09-05 11:14:33 +02:00
## Mobile App
2022-10-05 19:48:20 +02:00
* [iPhone](https://apps.apple.com/us/app/invoice-ninja-v5/id1503970375#?platform=iphone)
* [Android](https://play.google.com/store/apps/details?id=com.invoiceninja.app)
* [Linux](https://github.com/invoiceninja/flutter-mobile)
## Desktop App
* [MacOS](https://apps.apple.com/app/id1503970375)
* [Windows](https://microsoft.com/en-us/p/invoice-ninja/9n3f2bbcfdr6)
* [MacOS Desktop](https://snapcraft.io/invoiceninja)
2018-06-10 08:24:39 +02:00
## Installation Options
2018-03-25 12:02:45 +02:00
* [Ansible](https://github.com/invoiceninja/ansible-installer)
2022-03-12 09:49:54 +01:00
* [Self-Host Zip](https://invoice-ninja.readthedocs.io/en/latest/install.html)
2018-06-10 10:11:40 +02:00
* [Docker File](https://hub.docker.com/r/invoiceninja/invoiceninja/)
2018-02-18 09:09:13 +01:00
* [Cloudron](https://cloudron.io/store/com.invoiceninja.cloudronapp.html)
2017-05-09 14:50:02 +02:00
* [Softaculous](https://www.softaculous.com/apps/ecommerce/Invoice_Ninja)
2019-08-03 09:10:37 +02:00
* [Lando](https://github.com/invoiceninja/invoiceninja/issues/2880)
* [Yunohost](https://github.com/YunoHost-Apps/invoiceninja_ynh)
2015-04-30 19:54:19 +02:00
## Recommended Providers
2016-02-22 14:17:28 +01:00
* [Stripe](https://stripe.com/)
* [Postmark](https://postmarkapp.com/)
2016-12-08 08:57:13 +01:00
## Development
2018-07-26 17:41:30 +02:00
* [API Documentation](https://invoice-ninja.readthedocs.io/en/latest/api.html)
2017-02-14 11:37:10 +01:00
* [PHP SDK](https://github.com/invoiceninja/sdk-php)
* [Laminas Framework](https://github.com/alexz707/InvoiceNinjaModule)
2018-07-26 17:41:30 +02:00
* [Custom Module](https://invoice-ninja.readthedocs.io/en/latest/custom_modules.html) | [Watch Video](https://www.youtube.com/watch?v=8jJ-PYuq85k)
2016-11-13 22:47:51 +01:00
2018-03-21 10:51:49 +01:00
## Third Party Modules
* [Event Scheduler](https://github.com/cytech/Scheduler-InvoiceNinja)
2018-07-08 14:08:02 +02:00
* [Manufacturer Module](https://github.com/dicarlosystems/manufacturer-invoiceninja)
2019-10-27 10:41:19 +01:00
* [Point of Sale](https://github.com/dicarlosystems/pointofsale-invoiceninja)
2020-11-01 16:34:29 +01:00
* [Invoice Design Import/Export](https://github.com/feyst/invoicedesignexport)
2018-03-21 10:51:49 +01:00
> Feel free to email us for help if you're working on a module, we're happy to provide developer support.
## Third Party Tools
* [InvoicePlane Import](https://github.com/turbo124/Plane2Ninja)
* [Toggl Sync](https://github.com/Matth--/toggl-invoiceninja-sync)
* [Shopping Cart](https://github.com/Scifabric/invoiceninjashoppingcart)
2017-06-26 16:36:14 +02:00
## Third Party Developers
2019-01-30 11:45:46 +01:00
* [Bold Compass](https://boldcompass.com/customize-invoice-ninja/)
2017-06-26 16:37:52 +02: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/)
2017-05-18 11:36:08 +02:00
* [David Bomba](https://github.com/turbo124)
* [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)
2019-04-29 14:35:22 +02:00
* [Joshua Dwire](https://github.com/joshuadwire) - [Bold Compass](https://boldcompass.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/)
2017-04-28 09:08:28 +02:00
* [Alexander Zamponi](https://github.com/alexz707)
2017-06-25 09:08:19 +02:00
* [Matthieu Calie](https://github.com/Matth--)
2019-04-29 14:35:22 +02:00
* [Christopher Di Carlo](https://github.com/dicarlosystems) - [Di Carlo Systems Inc.](https://www.dicarlosystems.ca)
* [Kristian Feldsam](https://github.com/feldsam) - [FeldHost™](https://www.feldhost.net)
2019-04-25 14:50:46 +02:00
* [Suhas Sunil Gaikwad](https://github.com/Suhas-Gaikwad)
* [Mike Skaggs](https://github.com/titan-fail)
2015-10-07 21:25:35 +02:00
## License
2021-06-15 14:01:06 +02:00
Invoice Ninja is released under the Elastic License 2.0
2017-12-13 15:32:39 +01:00
See [LICENSE](LICENSE) for details.