Cutlery/invoiceninja
1
0
Fork 0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2025-10-31 13:47:32 -04:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #8161 from xeruf/readme

Browse Source 
Overhaul Readme
This commit is contained in:
David Bomba 2023-01-17 15:49:01 +11:00 committed by GitHub
commit aefd6fa8b0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 103 additions and 97 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

200
README.md
View File

@ -1,97 +1,103 @@
<p align="center"> <p align="center">
<img src="https://raw.githubusercontent.com/hillelcoren/invoice-ninja/master/public/images/round_logo.png" alt="Sublime's custom image"/> <img src="https://raw.githubusercontent.com/hillelcoren/invoice-ninja/master/public/images/round_logo.png" alt="Sublime's custom image"/>
</p> </p>
![v5-develop phpunit](https://github.com/invoiceninja/invoiceninja/workflows/phpunit/badge.svg?branch=v5-develop) ![v5-develop phpunit](https://github.com/invoiceninja/invoiceninja/workflows/phpunit/badge.svg?branch=v5-develop)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/d16c78aad8574466bf83232b513ef4fb)](https://www.codacy.com/gh/turbo124/invoiceninja/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=turbo124/invoiceninja&amp;utm_campaign=Badge_Grade) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/d16c78aad8574466bf83232b513ef4fb)](https://www.codacy.com/gh/turbo124/invoiceninja/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=turbo124/invoiceninja&amp;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> <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 # Invoice Ninja 5
## [Hosted](https://www.invoiceninja.com) | [Self-Hosted](https://www.invoiceninja.org) ## [Hosted](https://www.invoiceninja.com) | [Self-Hosted](https://www.invoiceninja.org)
### We're on Slack, join us at [slack.invoiceninja.com](http://slack.invoiceninja.com), [forum.invoiceninja.com](https://forum.invoiceninja.com) or if you like [StackOverflow](https://stackoverflow.com/tags/invoice-ninja/) Join us on [Slack](http://slack.invoiceninja.com), [Discourse](https://forum.invoiceninja.com) -
or [StackOverflow](https://stackoverflow.com/tags/invoice-ninja/) if you like,
Just make sure to add the `invoice-ninja` tag to your question. just make sure to add the `invoice-ninja` tag to your question.
## Introduction ## Introduction
Version 5 of Invoice Ninja is here! We've taken the best parts of version 4 and bolted on all of the most requested features to produce a invoicing application like no other. Version 5 of Invoice Ninja is here!
We took the best parts of version 4 and add the most requested features
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. to produce a invoicing application like no other.
* [Videos](https://www.youtube.com/@appinvoiceninja) All Pro and Enterprise features from the hosted app are included in the open code.
* [API Documentation](https://app.swaggerhub.com/apis/invoiceninja/invoiceninja) We offer a $30 per year white-label license to remove the Invoice Ninja branding from client facing parts of the app.
* [APP Documentation](https://invoiceninja.github.io/)
* [Support Forum](https://forum.invoiceninja.com) * [Videos](https://www.youtube.com/@appinvoiceninja)
* [StackOverflow](https://stackoverflow.com/tags/invoice-ninja/) * [API Documentation](https://app.swaggerhub.com/apis/invoiceninja/invoiceninja)
* [APP Documentation](https://invoiceninja.github.io/)
## Mobile Apps * [Support Forum](https://forum.invoiceninja.com)
* [iPhone](https://apps.apple.com/app/id1503970375?platform=iphone) * [StackOverflow](https://stackoverflow.com/tags/invoice-ninja/)
* [Android](https://play.google.com/store/apps/details?id=com.invoiceninja.app)
## Setup
## Desktop Apps
* [macOS](https://apps.apple.com/app/id1503970375?platform=mac) ### Mobile Apps
* [Windows](https://microsoft.com/en-us/p/invoice-ninja/9n3f2bbcfdr6) * [iPhone](https://apps.apple.com/app/id1503970375?platform=iphone)
* [Linux](https://snapcraft.io/invoiceninja) * [Android](https://play.google.com/store/apps/details?id=com.invoiceninja.app)
### Desktop Apps
## Installation Options * [macOS](https://apps.apple.com/app/id1503970375?platform=mac)
* [Docker File](https://hub.docker.com/r/invoiceninja/invoiceninja/) * [Windows](https://microsoft.com/en-us/p/invoice-ninja/9n3f2bbcfdr6)
* [Cloudron](https://cloudron.io/store/com.invoiceninja.cloudronapp.html) * [Linux](https://snapcraft.io/invoiceninja)
* [Softaculous](https://www.softaculous.com/apps/ecommerce/Invoice_Ninja)
### Installation Options
## Recommended Providers * [Docker File](https://hub.docker.com/r/invoiceninja/invoiceninja/)
* [Stripe](https://stripe.com/) * [Cloudron](https://cloudron.io/store/com.invoiceninja.cloudronapp.html)
* [Postmark](https://postmarkapp.com/) * [Softaculous](https://www.softaculous.com/apps/ecommerce/Invoice_Ninja)
### Recommended Providers
## Quick Start * [Stripe](https://stripe.com/)
* [Postmark](https://postmarkapp.com/)
```bash
git clone https://github.com/invoiceninja/invoiceninja.git ## Quick Hosting Setup
git checkout v5-stable
cp .env.example .env ```sh
composer update git clone https://github.com/invoiceninja/invoiceninja.git
php artisan key:generate git checkout v5-stable
``` cp .env.example .env
composer update
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. php artisan key:generate
```
Run if you want to load sample data, remember to configure .env
``` Please Note:
php artisan migrate:fresh --seed && php artisan db:seed && php artisan ninja:create-test-data 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
To run the web server ```sh
``` php artisan migrate:fresh --seed && php artisan db:seed && php artisan ninja:create-test-data
php artisan serve ```
```
To run the web server
Navigate to (replace ninja.test as required) ```sh
``` php artisan serve
http://ninja.test:8000/setup - To setup your configuration if you didn't load sample data. ```
http://ninja.test:8000/ - For Administrator Logon
Navigate to (replace localhost with the appropriate domain)
user: small@example.com ```
pass: password http://localhost:8000/setup - To setup your configuration if you did not load sample data.
http://localhost:8000/ - For Administrator Logon
http://ninja.test:8000/client/login - For Client Portal
user: small@example.com
user: user@example.com pass: password
pass: password
``` http://localhost:8000/client/login - For Client Portal
## Credits user: user@example.com
* [Hillel Coren](https://hillelcoren.com/) pass: password
* [David Bomba](https://github.com/turbo124) ```
* [Benjamin Beganović](https://github.com/beganovich)
* [All contributors](https://github.com/invoiceninja/invoiceninja/graphs/contributors) ## Credits
* [Hillel Coren](https://hillelcoren.com/)
## Security * [David Bomba](https://github.com/turbo124)
* [Benjamin Beganović](https://github.com/beganovich)
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) * [All Contributors](https://github.com/invoiceninja/invoiceninja/graphs/contributors)
## License ## Security
Invoice Ninja is released under the Elastic License.
See [LICENSE](LICENSE) for details. 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.