Cutlery/invoiceninja
1
0
Fork 0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2025-11-04 04:48:40 -05: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

50
README.md
View File

@ -10,15 +10,18 @@
## [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
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. 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) * [Videos](https://www.youtube.com/@appinvoiceninja)
* [API Documentation](https://app.swaggerhub.com/apis/invoiceninja/invoiceninja) * [API Documentation](https://app.swaggerhub.com/apis/invoiceninja/invoiceninja)
@ -26,29 +29,29 @@ All Pro and Enterprise features from the hosted app are included in the open-cod
* [Support Forum](https://forum.invoiceninja.com) * [Support Forum](https://forum.invoiceninja.com)
* [StackOverflow](https://stackoverflow.com/tags/invoice-ninja/) * [StackOverflow](https://stackoverflow.com/tags/invoice-ninja/)
## Mobile Apps ## Setup
### Mobile Apps
* [iPhone](https://apps.apple.com/app/id1503970375?platform=iphone) * [iPhone](https://apps.apple.com/app/id1503970375?platform=iphone)
* [Android](https://play.google.com/store/apps/details?id=com.invoiceninja.app) * [Android](https://play.google.com/store/apps/details?id=com.invoiceninja.app)
## Desktop Apps ### Desktop Apps
* [macOS](https://apps.apple.com/app/id1503970375?platform=mac) * [macOS](https://apps.apple.com/app/id1503970375?platform=mac)
* [Windows](https://microsoft.com/en-us/p/invoice-ninja/9n3f2bbcfdr6) * [Windows](https://microsoft.com/en-us/p/invoice-ninja/9n3f2bbcfdr6)
* [Linux](https://snapcraft.io/invoiceninja) * [Linux](https://snapcraft.io/invoiceninja)
### Installation Options
## Installation Options
* [Docker File](https://hub.docker.com/r/invoiceninja/invoiceninja/) * [Docker File](https://hub.docker.com/r/invoiceninja/invoiceninja/)
* [Cloudron](https://cloudron.io/store/com.invoiceninja.cloudronapp.html) * [Cloudron](https://cloudron.io/store/com.invoiceninja.cloudronapp.html)
* [Softaculous](https://www.softaculous.com/apps/ecommerce/Invoice_Ninja) * [Softaculous](https://www.softaculous.com/apps/ecommerce/Invoice_Ninja)
## Recommended Providers ### Recommended Providers
* [Stripe](https://stripe.com/) * [Stripe](https://stripe.com/)
* [Postmark](https://postmarkapp.com/) * [Postmark](https://postmarkapp.com/)
## Quick Hosting Setup
## Quick Start ```sh
```bash
git clone https://github.com/invoiceninja/invoiceninja.git git clone https://github.com/invoiceninja/invoiceninja.git
git checkout v5-stable git checkout v5-stable
cp .env.example .env cp .env.example .env
@ -56,27 +59,28 @@ composer update
php artisan key:generate 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. 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 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 php artisan migrate:fresh --seed && php artisan db:seed && php artisan ninja:create-test-data
``` ```
To run the web server To run the web server
``` ```sh
php artisan serve php artisan serve
``` ```
Navigate to (replace ninja.test as required) Navigate to (replace localhost with the appropriate domain)
``` ```
http://ninja.test:8000/setup - To setup your configuration if you didn't load sample data. http://localhost:8000/setup - To setup your configuration if you did not load sample data.
http://ninja.test:8000/ - For Administrator Logon http://localhost:8000/ - For Administrator Logon
user: small@example.com user: small@example.com
pass: password pass: password
http://ninja.test:8000/client/login - For Client Portal http://localhost:8000/client/login - For Client Portal
user: user@example.com user: user@example.com
pass: password pass: password
@ -86,11 +90,13 @@ pass: password
* [Hillel Coren](https://hillelcoren.com/) * [Hillel Coren](https://hillelcoren.com/)
* [David Bomba](https://github.com/turbo124) * [David Bomba](https://github.com/turbo124)
* [Benjamin Beganović](https://github.com/beganovich) * [Benjamin Beganović](https://github.com/beganovich)
* [All contributors](https://github.com/invoiceninja/invoiceninja/graphs/contributors) * [All Contributors](https://github.com/invoiceninja/invoiceninja/graphs/contributors)
## Security ## 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) 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 ## License
Invoice Ninja is released under the Elastic License. Invoice Ninja is released under the Elastic License.