README

financial-report

A rails app for generating some numbers to go in a financial report.

This README would normally document whatever steps are necessary to get the application up and running.

Work in progress

Set up

1. bundle install
2. rake db:migrate
3. bin/rails server
4. rake import:freeagent ~/Downloads/company-export-2017-06-30-10-14.xls
5. rake process:invoices
6. rake import:product_categories categories.csv

Then visit http://localhost:3010/reports/categories

Your categories CSV should have a header row followed by product category name and description pairs, if the name is left blank then the previous value is used, e.g.:

Name,Description
Hot Desk Day,1 Hot Desk Day
,2 Hot Desk Days
,3 Hot Desk Days
Permanent Desk,Permanent Desk
,Permanent Desk for Jo

Things you may want to cover:

• Ruby version

• System dependencies

• Configuration

• Database creation

• Database initialization

• How to run the test suite

• Services (job queues, cache servers, search engines, etc.)

• Deployment instructions

• ...