Update developer documentation - Githubissues

UUDigitalHumanitieslab / EDPOP

A virtual research environment (VRE) that lets you collect, align and annotate bibliographical and biographical records from several online catalogs.

BSD 3-Clause "New" or "Revised" License

1 stars 0 forks source link

Update developer documentation #164

Closed lukavdplas closed 2 months ago

lukavdplas commented 2 months ago

The README is missing some information that would be useful to developers, and is outdated.

Here is some information that should be included in the README (or a CONTRIBUTING file):

[ ] Mention that EDPOP is a web application.
[ ] Mention that the backend is based on Django and the frontend is based on Backbone. (Though the former is implied.)
[ ] Mention that the project uses RDF.
[ ] Link related repositories (edpop-explorer and RDF ontologies).
[ ] Installation instructions should direct the developer to install Blazegraph.
[ ] Specify recommended versions for Python, Blazegraph, PostgreSQL, Node

Also, these pieces of information should be updated or removed:

[ ] The backend README explains that all data is stored as JSON fields in PostgreSQL.
[ ] The backend README includes a link for installing PSQL on Ubuntu 14.04. For something more current, just link to https://www.postgresql.org/