From 6dbf3a88aeb82b8f6195f2cb3f00a105b135a079 Mon Sep 17 00:00:00 2001 From: Hillel Coren Date: Tue, 26 Nov 2013 16:18:45 +0200 Subject: [PATCH] Updating readme --- README.md | 27 +++++++++++++++++++++++---- 1 file changed, 23 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7a18cc5875ed..809e67f9d2fc 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,43 @@ # Invoice Ninja -## An open-source invoicing site built with Laravel +## Simple, Intuitive Invoicing ### Live Demo: [http://sketch-out.com/ninja/public/](http://sketch-out.com/ninja/public/) ### Introduction -Most online invoicing site are expensive. They shouldn't be. Hosting costs are cheaper than ever and the software isn't that complicated. The aim of this project is to provide a free, open-source alternative. Additionally, the hope is this codebase will serve a sample site for Laravel as well as other JavaScript technologies. +Most online invoicing site are expensive. They shouldn't be. The aim of this project is to provide a free, open-source alternative. Additionally, the hope is this codebase will serve as a sample site for Laravel as well as other JavaScript technologies. If you'd like to get involved please send an email to hillelcoren at gmail. ### Features -* Application framework built using Laravel 4 +* Core application built using Laravel 4 * Invoice PDF generation directly in the browser * Integrates with many payment providers ### Remaining Work * Recurring invoices -* Partial payments * Internationalization +* Home dashboard * Reports +### Steps to setup + +Clone Github project + + git clone git@github.com:hillelcoren/invoice-ninja.git ninja + + +Install packages using Composer + + cd ninja + composer install + +Configure the config/database.php file and then Initialize the database + + php artisan migrate + php artisan db:seed + + + ### Frameworks/Libraries * [laravel/laravel](https://github.com/laravel/laravel) - A PHP Framework For Web Artisans * [twbs/bootstrap](https://github.com/twbs/bootstrap) - Sleek, intuitive, and powerful front-end framework for faster and easier web development.