Mirrors/invoiceninja

Fork 0

mirror of https://github.com/invoiceninja/invoiceninja.git synced 2024-11-08 20:22:42 +01:00

David Bomba c60fd8c7c6 Improvements for using react with self hots

2022-11-13 09:35:04 +11:00

Invoice Ninja 5

Hosted | Self-Hosted

We're on Slack, join us at slack.invoiceninja.com, forum.invoiceninja.com or if you like StackOverflow

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.

The new interface has a lot more functionality so it isn't a carbon copy of v4, but once you get used to the new layout and functionality we are sure you will love it!

Referral Program

Earn 50% of Pro & Enterprise Plans up to 4 years - Learn more

Recommended Providers

Development

Quick Start

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

Contribution guide.

Code Style to follow PSR-2 standards.

All methods names to be in CamelCase

All variables names to be in snake_case

Where practical code should be strongly typed, ie your methods must return a type ie

public function doThis() : void

PHP >= 7.3 allows the return type Nullable so there should be no circumstance a type cannot be return by using the following:

public function doThat() ?:string

To improve chances of PRs being merged please include tests to ensure your code works well and integrates with the rest of the project.

Documentation

API documentation is hosted using Swagger and can be found HERE

Installation, Configuration and Troubleshooting documentation can be found [HERE] (https://invoiceninja.github.io)

Credits

Special thanks to:

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

License

Invoice Ninja is released under the Elastic License.
See LICENSE for details.

4.7 KiB Raw Blame History