isabella232 / ehri-frontend

The EHRI project's portal interface.

Front-end for the EHRI REST web service.

This app has a few depependencies in addition to the backend:

• A PostgreSQL 9.5+ database
• Solr, running configurated as per the config in EHRI Search Tools

The setup docs to get these dependencies up and running ended up horribly out-of-date, so rather than actively mislead people they've been temporarily removed pending the completion of some Docker -based dev setup instructions. In the meantime, here's how they'll start:

• Set up the search engine on port 8983:

  sudo docker run --publish 8983:8983 -it ehri/ehri-search-tools

• Set up the backend web service on port 7474:

  sudo docker run --publish 7474:7474 -it ehri/ehri-rest

• Set up PostgreSQL (Dockerised) with the right schema:

  sudo docker run -e POSTGRES_USER=docview -e POSTGRES_PASSWORD=changeme --publish 5432:5432 postgres

• Create an additional group on the backend named "portal":

curl  --header content-type:application/json \
      --header X-User:admin \
      --data-binary '{
           "id":"portal", 
           "type":"Group",
           "data":{"identifier": "portal", "name":"Portal"}
      }' \
      http://localhost:7474/ehri/classes/Group

• install postfix or a suitable email-sending program
• install Node JS (which handles client-side asset compilation)
• install sbt
• sbt run
• go to localhost:9000
• when you get a message about database evolutions being required, click "Apply this script now"
• create an account at http://localhost:9000/login
• get your new account ID, which can be found by looking at the URL for you account on the people page (http://localhost:9000/people). It should be user000001.
• make developer account an admin on the backend (replace {userId} with actual ID):

curl -X POST \
       --header X-User:admin \
       http://localhost:7474/ehri/classes/Group/admin/{userId}

• make account verified and staff on the front end (replace {userId} with actual ID and use default password 'changeme'):

psql -hlocalhost -Udocview docview \
       -c "update users set verified = true, staff = true where id = '{userId}'"

At this point you should be able to access the admin pages and create data, e.g:

• create a country record at http://localhost:9000/admin/countries/create. You only have to provide the country code, e.g. "us"
• create an institution in that country
• create archival records in the institution

NOTE: certain functionality also depends on a valid AWS S3 configuration set in the conf/aws.conf file. Use the conf/aws.conf.example as a template.

Testing

Running integration tests requires an instance of the backend service running locally on port 7575. This can be done with a single Docker command:

sudo docker run --publish 7575:7474 -it ehri/ehri-rest