“Bluetrait Money” Documentation by “Michael Dale” v1.2
“Bluetrait Money”
Created: 9/4/2012
By: Michael Dale
Email: mdale@dalegroup.net
Thank you for purchasing Bluetrait Money. If you have any questions that are beyond the scope of this help file, please feel free to email via my user page contact form here. Thanks so much!
Table of Contents
Welcome - top
Welcome to Bluetrait Money.
Bluetrait Money is an online multi user web application designed to keep track of your shopping list, recipes and money tracking.
It is great for shared households or families who wish to keep track of who spends what.
You can create your own recipes and add the recipe items to your shopping list.
You can also generate a report once a month to get a break down (with your own custom cateogories) of where your money went
Bluetrait Money supports the English Language and the dollar ($) only.
Bluetrait Money is designed to be a stand alone web application, you are of course welcome to modify the code, but I cannot support modified code if it breaks.
Whenever I release a new version of Bluetrait Money a upgrade script is included (more below), please make sure you keep Bluetrait Money up to date.
Please note: If you modify the Bluetrait Money code the upgrade script may fail. It will be up to you to fix this if a problem occurs. You must support your own code changes.
Features - top
Bluetrait Money includes 3 main features.
- Household Expense Tracking (the Board)
- Shopping List
- Recipe Storage
Household Expense Tracking
Shopping List
Recipe Storage
System Requirements - top
Bluetrait Money is written in PHP5.2 and uses a MySQL5 database. Bluetrait Money is a "Web Application" that must be installed on a Web Server. Bluetrait Money will do a basic check of your web server during the install.
You must install Bluetrait Money on a web host that supports PHP5.2, MySQL5 and Apache (recommended).
You may also install Bluetrait Money on your personal computer by using one of the many options (i.e google WAMPserver or XAMPP), this is not covered in this document.
The full system requirements can be found below.
- PHP 5.2+
- MySQL 5+ (MySQL 4 might work but is untested) with 1 empty database
- PHP PDO Extension
- PHP able to write files to the installed directory
- Apache (might work with IIS but is untested)
- A Web Browser that supports HTML5/Javascript (for the client)
Install - top
There are a number of steps required to install Bluetrait Money.
- Copy the unzipped contents of the zip file to somewhere on your webserver. You can install Bluetrait Money in a folder on your existing web hosting or setup a new subdomain.
- Create an empty MySQL database (most hosting provides a control panel that allows you to do this).
- Ensure your PHP install can create files (for b-config.php to be created during the install).
- Run http://board.example.com/b-install/ from your web browser.
- Follow the steps.
- After install make sure you run http://board.example.com/b-upgrade.php to upgrade the database to the latest version (you will need to be logged in with the details you setup in step 5 in the installer).
- For the reports to be automatically generated each month please run a cron script that hits http://board.example.com/b-cron.php at least once a day.
After Install - top
There are a number of things that you should do after install to customise your Bluetrait Money install.
First you should create any users that will access the system. Currently all users are reported on the monthly report.
To do this simply click Admin and then Add/Edit User.
The board Menu is where all the payments you want to keep track of are kept.
To setup the Categories for your boards (e.g Shopping, Takeaway, Electricity) simply click Admin and then Add/Edit Category under the Board menu
Multiple Boards allow you to split up your payment items and monthly reports into separate groups. For most users only a single Board will be required. Simply click Admin and then Add/Edit Boards.
Recipe Categories allow you to organise your recipes (e.g Entree, Main, Gluten Free etc). To add simply click Admin and then Add/Edit Category under the Recipes menu.
Upgrading - top
Upgrading should be pretty easy.
- Download the latest version of the Bluetrait Money zip file
- Backup your MySQL database and b-config.php file.
- Backup any custom code or changes you have made (this will be overwritten).
- Unzip the new install onto your local computer.
- Delete the b-install/ folder.
- Upload this to your existing install of Bluetrait Money replacing all existing files.
- Login
- Run the database upgrade http://board.example.com/b-upgrade.php
Release Log - top
Key
+ New Feature * Bug Fix - Other Change
Version 1.2
- + You can now set a default Board (set in Site Configuration)
- + You can now delete a report
- - When adding recipe items to the shopping list, empty quantities are not added (only the ingredient name is added)
- - Other minor fixes and improvements
Version 1.1
- + JQuery datepicker when adding board items
- + You can now select multiple categories in Recipe search
- + Admin/Owner Permissions
- + You can now change a users password
- + Shopping Count updated when deleting a shopping list item.
Version 1.0
- + New HTML5 Graphs
- + Ajax delete of shopping list items
- + You can now search recipes
- + You can now enable HTTPs from Site Configuration (after install)
- + You can now setup SMTP server details from Site Configuration (after install)
- + Javascript confirm delete when deleting a recipe.
- * Recipe Quantities are now populated
- - Changed "items" to "board" and other interface fixes
Credits - top
- Michael Dale - Developer
- Matthew Costa - Initial interface redesign
Once again, thank you so much for purchasing this web application. As I said at the beginning, I'd be glad to help you if you have any questions relating to Bluetrait Money. No guarantees, but I'll do my best to assist.
Michael Dale