diff --git a/README.md b/README.md index 0c5c0004200b..a9bc5a50c46a 100644 --- a/README.md +++ b/README.md @@ -1,97 +1,103 @@ -

- Sublime's custom image -

- -![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&utm_medium=referral&utm_content=turbo124/invoiceninja&utm_campaign=Badge_Grade) -CLA assistant - -# Invoice Ninja 5 - -## [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/) - -Just make sure to add the `invoice-ninja` tag to your question. - -## 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. - -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://app.swaggerhub.com/apis/invoiceninja/invoiceninja) -* [APP Documentation](https://invoiceninja.github.io/) -* [Support Forum](https://forum.invoiceninja.com) -* [StackOverflow](https://stackoverflow.com/tags/invoice-ninja/) - -## Mobile Apps -* [iPhone](https://apps.apple.com/app/id1503970375?platform=iphone) -* [Android](https://play.google.com/store/apps/details?id=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 Start - -```bash -git clone https://github.com/invoiceninja/invoiceninja.git -git checkout v5-stable -cp .env.example .env -composer update -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 -``` -php artisan migrate:fresh --seed && php artisan db:seed && php artisan ninja:create-test-data -``` - -To run the web server -``` -php artisan serve -``` - -Navigate to (replace ninja.test as required) -``` -http://ninja.test:8000/setup - To setup your configuration if you didn't load sample data. -http://ninja.test:8000/ - For Administrator Logon - -user: small@example.com -pass: password - -http://ninja.test: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. +

+ Sublime's custom image +

+ +![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&utm_medium=referral&utm_content=turbo124/invoiceninja&utm_campaign=Badge_Grade) +CLA assistant + +# Invoice Ninja 5 + +## [Hosted](https://www.invoiceninja.com) | [Self-Hosted](https://www.invoiceninja.org) + +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. + +## 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://app.swaggerhub.com/apis/invoiceninja/invoiceninja) +* [APP Documentation](https://invoiceninja.github.io/) +* [Support Forum](https://forum.invoiceninja.com) +* [StackOverflow](https://stackoverflow.com/tags/invoice-ninja/) + +## Setup + +### Mobile Apps +* [iPhone](https://apps.apple.com/app/id1503970375?platform=iphone) +* [Android](https://play.google.com/store/apps/details?id=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 update +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.