CRIM-Project / CRIM-online

Django project for CRIM (Citations: The Renaissance Imitation Mass)
6 stars 4 forks source link

Added initial pass at setup docs and data-load script #72

Closed serberoth closed 1 year ago

serberoth commented 1 year ago

I have added a bit of setup documentation and a script to help perform an initial load of the data into the database.

This is a first pass at better document the local setup process to make it simpler/easier for folks to get onboarded and help out with the project.

The settings_development.py configuration file has some basic settings based on the CRIM production values with some saner values for development turning on additional debugging settings these SHOULD NOT be used in any production environment, but do assist with development.

The data-load.py script can load JSON content into the database it will make the migrations perform the migrations and then attempt to load the specified scripts into the database. The script takes a single argument which is a path to the JSON data. Then it attempts to load that data into the database in the order specified in the script, looking for files with the specified names in the items list. Also the items will be imported in the specified order, which may or may not be the correct order for importing that data into the database.

Please review this content before merging into the project so we can discuss if any updates or clarifications are necessary. Thank you.