On this page:
Note: Over the course of the project, the terminology has changed, with the result that different areas of the codebase use different names for the same concepts.
While we aspire to eventually to update for consistency, in the meantime, these three terms listed below are used interchangeably in code. The first listed option (in bold) is the one currently used by the project, and the term used in the database is indicated by db
:
db
db
db
/ person / entrant(Assumes Docker is installed and running.)
From the terminal, run:
git clone git@github.com:Brown-University-Library/stolen_relations_start_data.git
git clone git@github.com:Brown-University-Library/disa_dj_project.git
cd disa_dj_project
docker-compose up
The webapp should be running; from a browser, go to http://127.0.0.1:8000/version/
or http://127.0.0.1:8000/login/
.
cd <SOME_PATH>/disa_dj_project
docker-compose up
Note: if a code-update installs a new python-package, either:
disa_dj_project-web
image which should force it to be rebuilt (best option), or... docker-compose up --build
to force the container to be rebuilt. (I don't think this actually creates a new image, so subsequent runs of docker-compose up
will still use the old image.)Some critical files:
Django settings for disa_project. Mostly "where are things" and security keys, etc.
Generated by 'django-admin startproject' using Django 1.11.
Full list of settings and their values
Maps URL patterns to views, e.g.:
url( r'^editor/documents/(?P<cite_id>.*)/$', views.edit_citation, name='edit_citation_url' )
which maps to the function definition in disa_dj_project/disa_app/views.py:
@shib_login
def edit_citation( request, cite_id=None ):
Seems to extend administrative functions, and handles the "marked for deletion" system. Contains 3 class definitions:
The templates for the public pages. These files are referenced in disa_app/views.py
.
A bunch of DISA-specific python code. This seems to be the main code area.
Includes:
generate_browse_data.py
view_*_manager.py
Model definition for SQL Alchemy
Not sure (ask Birkin)
Some random settings—authentication, DB location, etc. Not sure how this relates to disa_dj_project/config/settings.py
A bunch of routines that are called by disa_dj_project/config/urls.py
and reference disa_dj_project/disa_app/disa_app_templates
.