Proof-of-Concept Demo: Philanthropy Data Commons (PDC) -- Common Data Platform

This is a demonstration project to show what a common grant application for philanthropy might look like. See the use cases documentation for more details about what this demo shows and why, and the core fields list for the set of fields we have so far identified as being common to many grant applications.

Please note that this software is for demonstration purposes only and is NOT meant to run in production. The APIs are public, with no authorization controls. There is a live demo site at cgap.opentechstrategies.com/poc-demo. The demo site uses entirely made-up sample data that may be refreshed or deleted at any time.

There are a draft architecture diagram and a draft entity relationship diagram (ERD) in the docs directory; both are available as PDF and PNG. These diagrams are works-in-progress and should not be considered final. There are also a number of screenshots available in the images directory (as well as a few in cgap/static/images that are actually displayed by the application itself). Screenshots are not guaranteed to be up-to-date with respect to the code.

Setting Up

This project uses pipenv to manage dependencies. Data runs via SQLLite3

To set up your development environment run:

$ pipenv install

Then set up the database via:

pipenv run flask init-db --seed

Running Locally

Once you have set up your environment you can run the project via flask:

$ export FLASK_APP=pdc
$ pipenv run flask run

Running on Production

This project has a WSGI entry point if you want to use something like gunicorn.

Gunicorn has been added as a project dependency, and so you can run a production copy by typing:

$ pipenv run gunicorn --reload --bind 127.0.0.1:9090 wsgi:app

This could be set up using the process manager of your chice (e.g. supervisord)