Installation - ccnmtl/footprints Wiki
REQUIREMENTS
Python 3.8
PostgresSQL with PostGIS geo-aware extensions
Solr 3+
Celery 3
NOTES
- In development, Footprints can be configured to use an in-memory Celery configuration and a simple search backend.
- Footprints uses SpatiaLite to run unit tests.
- See the Local Solr Instance page for more information on how to develop Footprints locally.
INSTALLATION
-
If you are planning to contribute to the project, first fork the repository into your own account.
-
Clone Footprints into your local development environment.
-
Build the PostgresSQL database
A. Make sure you have PostGIS installed and configured.
B. Create the databasecreatedb footprints
-
Customize settings
Create a local_settings.py file in the footprints subdirectory. Override the variables fromsettings_shared.py
that you need to customize for your local installation. At a minimum, you will need to customize yourDATABASES
dictionary. See the example local_settings.py file for more information. -
Build Footprints uses a Makefile to control the build. Simply run
make
to build the virtualenv and run tests. -
Sync the database
make migrate
-
Run locally (during development only)
make runserver