From 04bf5e23d7e8e60ed2bb820a08ed5b238e4ea4e9 Mon Sep 17 00:00:00 2001 From: David Bomba Date: Fri, 11 Oct 2019 07:29:46 +1100 Subject: [PATCH] Update README.md --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index df0bfa0373..4a0971c321 100644 --- a/README.md +++ b/README.md @@ -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.