2018-10-05 09:52:12 +02:00
< p align = "center" >
< img src = "https://raw.githubusercontent.com/hillelcoren/invoice-ninja/master/public/images/round_logo.png" alt = "Sublime's custom image" / >
< / p >
2018-10-05 09:39:34 +02:00
2019-03-26 04:08:19 +01:00
[](https://travis-ci.org/invoiceninja/invoiceninja)
2019-04-20 00:58:01 +02:00
[](https://codecov.io/gh/invoiceninja/invoiceninja)
2018-10-05 14:46:53 +02:00
[](https://www.codacy.com/app/turbo124/invoiceninja?utm_source=github.com& utm_medium=referral& utm_content=invoiceninja/invoiceninja& utm_campaign=Badge_Grade)
2018-10-05 14:59:26 +02:00
2019-08-26 10:36:15 +02:00
# Invoice Ninja version 2.0 is coming!
2018-10-05 09:39:34 +02:00
We will be using the lessons learnt in Invoice Ninja 4.0 to build a bigger better platform to work from. If you would like to contribute to the project we will gladly accept contributions for code, user guides, bug tracking and feedback! Please consider the following guidelines prior to submitting a pull request:
2019-10-10 22:30:14 +02:00
## Quick Start
2019-10-10 22:29:46 +02:00
2019-11-30 23:59:51 +01:00
Currently the client portal and API are of alpha quality, to get started:
2019-10-10 22:29:46 +02:00
```bash
git clone https://github.com/invoiceninja/invoiceninja.git
git checkout v2
2019-10-10 22:52:54 +02:00
cp .env.example .env
2019-10-11 11:56:32 +02:00
cp .env.dusk.example .env.dusk.local
2019-10-10 22:29:46 +02:00
composer update
npm i
npm run production
php artisan migrate:fresh --seed & & php artisan db:seed --class=RandomDataSeeder
```
Navigate to
2019-10-10 22:30:14 +02:00
```
2019-10-10 22:29:46 +02:00
http://ninja.test:8000/client/login
user: user@example.com
pass: password
```
2019-10-10 22:30:14 +02:00
2019-08-26 10:36:15 +02:00
## Contribution guide.
2018-10-05 09:39:34 +02:00
Code Style to follow [PSR-2 ](https://www.php-fig.org/psr/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`
2019-07-09 11:43:24 +02:00
PHP >= 7.3 allows the return type Nullable so there should be no circumstance a type cannot be return by using the following:
2018-10-05 09:39:34 +02:00
`public function doThat() ?:string`
2019-08-26 10:36:15 +02:00
To improve chances of PRs being merged please include tests to ensure your code works well and integrates with the rest of the project.
2019-08-26 03:12:37 +02:00
2019-08-26 10:36:15 +02:00
## Documentation
2019-08-26 03:12:37 +02:00
2019-11-18 21:54:10 +01:00
API documentation is hosted using Swagger and can be found [HERE ](https://app.swaggerhub.com/apis/invoiceninja/invoiceninja )
2019-08-26 10:36:15 +02:00
## Current work in progress
Invoice Ninja is currently being written in a combination of Laravel for the API and Client Portal and Flutter for the front end management console. This will allow an immersive and consistent experience across any device: mobile, tablet or desktop.
To manage our workflow we will be creating separate branches for the client (Flutter) and server (Laravel API / Client Portal) and merge these into a release branch for deployments.
