usaspending-api | Server application to serve US federal spending data via a RESTful API | REST library

There are three documented options for setting up a local database in order to run the API:.
Local Empty DB. Use your own local postgres database for the API to use.
Containerized Empty DB. Create an empty directory on your localhost where all the database files will persist and use the docker-compose file to bring up a containerized postgres database.
Local Populated DB. Download either the whole database or a database subset from the USAspending website.
Postgres Setup Help
Docker Compose
If you run a local database, set POSTGRES_HOST in .env to host.docker.internal. POSTGRES_PORT should be changed if it isn't 5432. docker-compose up usaspending-db will create and run a Postgres database. docker-compose run --rm usaspending-manage python3 -u manage.py migrate will run Django migrations: https://docs.djangoproject.com/en/2.2/topics/migrations/. docker-compose run --rm usaspending-manage python3 -u manage.py load_reference_data will load essential reference data (agencies, program activity codes, CFDA program data, country codes, and others). docker-compose run --rm usaspending-manage python3 -u manage.py matview_runner --dependencies will provision the materialized views which are required by certain API endpoints.
docker-compose.yaml contains the shell commands necessary to set up the database manually, if you prefer to have a more custom environment.
Some of the API endpoints reach into Elasticsearch for data.
docker-compose up usaspending-es will create and start a single-node Elasticsearch cluster, using the ES_CLUSTER_DIR specified in the .env configuration file. We recommend using a folder outside of the usaspending-api project directory so it does not get copied to other containers.
The cluster should be reachable via at http://localhost:9200 ("You Know, for Search").
Optionally, to see log output, use docker-compose logs usaspending-es (these logs are stored by docker even if you don't use this).
To run all USAspending tests in the docker services run.
Postgres A running PostgreSQL database server (See Database Setup above)
Elasticsearch A running Elasticsearch cluster (See Elasticsearch Setup above)
Required Python Libraries Python package dependencies downloaded and discoverable (See below)
Environment Variables Tell python where to connect to the various data stores (See below)