Setting up a development environment

Prerequisite

• Docker

---

Installation Instructions

Get code

$ git clone https://github.com/LD4P/qa_server_container.git
$ cd qa_server_container

---

Setup environment variables

• create a .env file by copying .env.example and renaming to .env
• edit .env
  • update anything marked CHANGEME
  • change other environment variables if needed

---

Setup authority configurations

Outside the app directory, clone the pre-configured authorities from: LD4P/linked_data_authorities

   git clone [email protected]:LD4P/linked_data_authorities.git

   cd linked_data_authorities

Inside the linked_data_authorities directory, there are subdirectories for each available authority (e.g., qa_agrovoc, qa_dbpedia, etc.) followed by subdirectories for each version of the authority (e.g., 1.0, 2.0, 2.1, etc.)

Directory Layout

########################
### Directory Layout ###
########################

  - linked_data_authorities/
    - qa_agrovoc/
      - 1.0/
        - config/
          - authorities/
            - linked_data/
              - scenarios/
                - agrovoc_direct_validation.yml
                - agrovoc_ld4l_cache_validation.yml
              - agrovoc_direct.json
              - agrovoc_ldfl_cache.json
      - 2.0/
        - config/
          - authorities/
            - linked_data/
              - scenarios/
                - agrovoc_direct_validation.yml
                - agrovoc_ld4l_cache_validation.yml
              - agrovoc_direct.json
              - agrovoc_ldfl_cache.json
      - 2.1/
        - config/
          - authorities/
            - linked_data/
              - scenarios/
                - agrovoc_direct_validation.yml
                - agrovoc_ld4l_cache_validation.yml
              - agrovoc_direct.json
              - agrovoc_ldfl_cache.json
      - README.MD

Select the Authority and version you wish to use and copy the authorities directory and all its contents to the config directory of the qa_server_container app.

#########################################################################
### Example of what to copy into qa_server_container config directory ###
#########################################################################

  - authorities/
    - linked_data/
      - scenarios/
        - agrovoc_direct_validation.yml
        - agrovoc_ld4l_cache_validation.yml
      - agrovoc_direct.json
      - agrovoc_ldfl_cache.json

There are a number of pre-configured authorities at LD4P/linked_data_authorities. Some of these require a cache of the data. A few are able to make direct access through the authority provider's API. This information is documented at LD4P/linked_data_authorities.

---

To Start the Server

Run app with Docker by executing these commands from the root directory of the app

$ docker-compose build
$ docker-compose up

To Stop the Server

$ docker-compose down