Update README.md

This commit is contained in:
David Bomba 2019-10-11 07:29:46 +11:00 committed by GitHub
parent 87d5e50557
commit 04bf5e23d7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -10,6 +10,25 @@
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:
# Quick Start
Curently the client portal and API are of alpha quality, to get started:
```bash
git clone https://github.com/invoiceninja/invoiceninja.git
git checkout v2
composer update
npm i
npm run production
php artisan migrate:fresh --seed && php artisan db:seed --class=RandomDataSeeder
```
```
Navigate to
http://ninja.test:8000/client/login
user: user@example.com
pass: password
```
## Contribution guide.
Code Style to follow [PSR-2](https://www.php-fig.org/psr/psr-2/) standards.