supporters/README.md

37 lines
1.3 KiB
Markdown
Raw Normal View History

2015-12-30 19:07:31 +00:00
Mini Non-Profit Supporters and Donors Database
==============================================
"Supporters" is a small donor database for non-profit fundraising that uses
Ledger-CLI as a backend for accounting data.
While this system is used in production for Software Freedom Conservancy, the
code is likely only appropriate if you plan to do a lot of work on the
command-line. Eventually, the ideal would be to refactor CiviCRM to support
the ideas and Ledger-CLI integration represented in this code.
Why Does This Exist?
--------------------
Conservancy needed a simple donor database and could not invest the resources
required to maintain a CiviCRM instance: most organizations that use CiviCRM
either pay for hosting or devote some amount of staff time its maintenance.
Conservancy could afford neither, but this weekend-hack version of a database
suits our needs (at least for now).
2015-12-30 19:08:14 +00:00
License Information
-------------------
See the file [LICENSE.md](LICENSE.md) for license information.
2015-12-30 19:07:31 +00:00
Common Tasks
------------
These are recipes for some common tasks that one might want to complete on
the command line with the Supporters database.
2015-12-31 06:47:55 +00:00
* Add a Supporter from the command line:
./scripts/add-supporter.plx <DBFILE>
2015-12-31 08:38:59 +00:00
* Add an email address, or change the preferred email address:
./scripts/add-email-address.plx <DBFILE>