From 8c7bd7a1f6627cee8634ec5f1fa9fe069df2f148 Mon Sep 17 00:00:00 2001 From: Andrew Wippler Date: Tue, 16 May 2017 17:23:19 -0700 Subject: [PATCH] Updating README --- README.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index bcd72e2..bbbe966 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,39 @@ -# 2 by 2 +# 2 by 2 - Personal Prospect Tracker [![Build Status](https://travis-ci.org/andrewwippler/2by2.svg?branch=master)](https://travis-ci.org/andrewwippler/2by2) -A work in progress.... please ignore the dust. -## setup +This is my rendition of a personal prospect tracker for Soul Winning. You may [use my personal installation](https://2by2.andrewwippler.com), but you may want to set up your own to personalize all the options. + +## Setup ```bash -git clone +cd /var/www/html +git clone https://github.com/andrewwippler/2by2.git cd 2by2 cp .env{.example,} +# edit .env with database information php artisan key:generate +composer install +php artisan migrate +php artisan db:seed +npm install +npm run production ``` +Note: first registered user becomes admin. + +## Todo: + + -[] Personal Reports + -[] Site-wide Reporting + -[] Assign admin + -[] Team Leader Role (to view all in team) + -[] Sunday School Leader Role (to view all in SS) + -[] Ordering of items + -[] Contact history icons + -[] Metrics on actions done + -[] Un-delete Prospects items + + # License Copyright 2017 Andrew Wippler