mirror of
https://github.com/invoiceninja/invoiceninja.git
synced 2024-11-14 15:13:29 +01:00
102 lines
3.8 KiB
Markdown
102 lines
3.8 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>
|
|
|
|
|
|
[](https://www.codacy.com/gh/turbo124/invoiceninja/dashboard?utm_source=github.com&utm_medium=referral&utm_content=turbo124/invoiceninja&utm_campaign=Badge_Grade)
|
|
<a href="https://cla-assistant.io/invoiceninja/invoiceninja"><img src="https://cla-assistant.io/readme/badge/invoiceninja/invoiceninja" alt="CLA assistant" /></a>
|
|
|
|
# Invoice Ninja 5
|
|
|
|
## [Hosted](https://www.invoiceninja.com) | [Self-Hosted](https://www.invoiceninja.org)
|
|
|
|
Join us on [Slack](http://slack.invoiceninja.com), [Discord](https://discord.gg/ZwEdtfCwXA), [Support Forum](https://forum.invoiceninja.com)
|
|
|
|
## Introduction
|
|
|
|
Version 5 of Invoice Ninja is here!
|
|
We took the best parts of version 4 and add the most requested features
|
|
to produce a invoicing application like no other.
|
|
|
|
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.
|
|
|
|
* [Videos](https://www.youtube.com/@appinvoiceninja)
|
|
* [API Documentation](https://api-docs.invoicing.co/)
|
|
* [APP Documentation](https://invoiceninja.github.io/)
|
|
* [Support Forum](https://forum.invoiceninja.com)
|
|
|
|
## Setup
|
|
|
|
### Mobile Apps
|
|
* [iPhone](https://apps.apple.com/app/id1503970375?platform=iphone)
|
|
* [Android](https://play.google.com/store/apps/details?id=com.invoiceninja.app)
|
|
* [F-Droid](https://f-droid.org/en/packages/com.invoiceninja.app)
|
|
|
|
### Desktop Apps
|
|
* [macOS](https://apps.apple.com/app/id1503970375?platform=mac)
|
|
* [Windows](https://microsoft.com/en-us/p/invoice-ninja/9n3f2bbcfdr6)
|
|
* [Linux](https://snapcraft.io/invoiceninja)
|
|
|
|
### Installation Options
|
|
* [Docker File](https://hub.docker.com/r/invoiceninja/invoiceninja/)
|
|
* [Cloudron](https://cloudron.io/store/com.invoiceninja.cloudronapp.html)
|
|
* [Softaculous](https://www.softaculous.com/apps/ecommerce/Invoice_Ninja)
|
|
|
|
### Recommended Providers
|
|
* [Stripe](https://stripe.com/)
|
|
* [Postmark](https://postmarkapp.com/)
|
|
|
|
## Quick Hosting Setup
|
|
|
|
```sh
|
|
git clone https://github.com/invoiceninja/invoiceninja.git
|
|
git checkout v5-stable
|
|
cp .env.example .env
|
|
composer i -o --no-dev
|
|
php artisan key:generate
|
|
```
|
|
|
|
Please Note:
|
|
Your APP_KEY in the .env file is used to encrypt data, if you lose this you will not be able to run the application.
|
|
|
|
Run if you want to load sample data, remember to configure .env
|
|
```sh
|
|
php artisan migrate:fresh --seed && php artisan db:seed && php artisan ninja:create-test-data
|
|
```
|
|
|
|
To run the web server
|
|
```sh
|
|
php artisan serve
|
|
```
|
|
|
|
Navigate to (replace localhost with the appropriate domain)
|
|
```
|
|
http://localhost:8000/setup - To setup your configuration if you did not load sample data.
|
|
http://localhost:8000/ - For Administrator Logon
|
|
|
|
user: small@example.com
|
|
pass: password
|
|
|
|
http://localhost:8000/client/login - For Client Portal
|
|
|
|
user: user@example.com
|
|
pass: password
|
|
```
|
|
|
|
## Credits
|
|
* [Hillel Coren](https://hillelcoren.com/)
|
|
* [David Bomba](https://github.com/turbo124)
|
|
* [Benjamin Beganović](https://github.com/beganovich)
|
|
* [All Contributors](https://github.com/invoiceninja/invoiceninja/graphs/contributors)
|
|
|
|
## Security
|
|
|
|
If you find a security issue with this application, please send an email to contact@invoiceninja.com.
|
|
Please follow responsible disclosure procedures if you detect an issue.
|
|
For further information on responsible disclosure please read [here](https://cheatsheetseries.owasp.org/cheatsheets/Vulnerability_Disclosure_Cheat_Sheet.html).
|
|
|
|
## License
|
|
Invoice Ninja is released under the Elastic License.
|
|
See [LICENSE](LICENSE) for details.
|