A framework for transparently communicating the costs, financial situation and capital sources of a Website/Service/Organisation/etc.
Features:
- fully responsive One-Pager Template, Short-Report-Patches and Status-Badges for you to include where needed
- Method to organize costs on Github (with a free account there)
In The future:
- Offline-tool, to help updating finances easily
Take a look at the Demo.
The financial report gains user trust, let’s them participate in optimizing your costs and lets potential donors/members/etc. make an informed decision on if they want to help sustaining this project.
keywords: finances, cost reporting, sustaining microsites and microservices, controlling
Fundwork relies on Jquery, Bootstrap and the beautiful Chart.js. So make Sure to have them ready before loading a fundwork report, patch or badge.
Add these to the html-page you wish to use Fundwork on:
<script src="https://cdn.jsdelivr.net/gh/TheBlune/FundWork@0.0.4/fundwork.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/TheBlune/FundWork@0.0.4/fundwork.css">
then call fundwork(costLocation,costLink,message,neededBuffer) in your .js-file.
Fundwork will try to load a costs.json file to get the data needed to display. You will need to prepare this file, before using fundwork. Find info here: FundworkCostTemplate
Fundwork takes 4 arguments:
- costLocation: Put "Github" here, if your costs.json-file is hosted on Github
- costURL: The link to the costs.json-file. Can be either a direct link to a file on a server or raw-link of the cost-file hosted on github: https://raw.githubusercontent.com/TheBlune/FundworkCostTemplate/main/costs.json
- repolink: Link the cost-files Github-Repo/Branch, so that users may propose cost optimizations. If no inpus is given, button is not shown.
- reportLink: If you only show a Patch or Batch: set a link to the full financial report here, like e.g. https://theblune.github.io/FundWork/
- Message: A personalizable Message to add to the top of a fundwork-report. See Example fundwork.js call for templates
- neededBuffer: Is used to emphasize to the readers, that the project is either "under-funded" or already enough funded. Put the number of Months in here, that you want your project to be a operational for (based on current Capital).
Here you may find real-world examples of pages using this framework.