Sign inSign up

etutorplusplus/task-app-binary-search

By etutorplusplus

•Updated about 2 years ago

Demo Task-App: Binary Search

Image
0

1.9K

etutorplusplus/task-app-binary-search repository overview

⁠eTutor Task-App: Binary Search

This application provides a REST-interface for following task type: binary_search.

Students have to guess a number. The student's input is compared with the number stored in the solution, and it is returned whether the number sought is smaller, equal to or greater than the input.

⁠Docker

Start a new instance of the application using Docker:

docker run -p 8090:8081 \ 
  -e SPRING_DATASOURCE_URL="jdbc:postgresql://postgres:5432/etutor_binary_search" \
  -e SPRING_DATASOURCE_USERNAME=etutor_binary_search \
  -e SPRING_DATASOURCE_PASSWORD=myPwd \
  -e SPRING_FLYWAY_USER=etutor_binary_search_admin \
  -e SPRING_FLYWAY_PASSWORD=adPwd \
  -e CLIENTS_API_KEYS_0_NAME=task-administration \
  -e CLIENTS_API_KEYS_0_KEY=some-secret-key \
  -e CLIENTS_API_KEYS_0_ROLES_0=CRUD \
  -e CLIENTS_API_KEYS_0_ROLES_1=SUBMIT \
  -e CLIENTS_API_KEYS_1_NAME=moodle \
  -e CLIENTS_API_KEYS_1_KEY=another-secret-key \
  -e CLIENTS_API_KEYS_1_ROLES_0=SUBMIT \
  -e CLIENTS_API_KEYS_2_NAME=plagiarism-checker \
  -e CLIENTS_API_KEYS_2_KEY=key-for-reading-submissions \
  -e CLIENTS_API_KEYS_2_ROLES_0=READ_SUBMISSION \
  etutorplusplus/task-app-binary-search

or with Docker Compose:

version: '3.8'

services:
    task-app-binary-search:
        image: etutorplusplus/task-app-binary-search
        restart: unless-stopped
        ports:
            -   target: 8081
                published: 8090
        environment:
            SPRING_DATASOURCE_URL: jdbc:postgresql://postgres:5432/etutor_binary_search
            SPRING_DATASOURCE_USERNAME: etutor_binary_search
            SPRING_DATASOURCE_PASSWORD: myPwd
            SPRING_FLYWAY_USER: etutor_binary_search_admin
            SPRING_FLYWAY_PASSWORD: adPwd
            CLIENTS_API_KEYS_0_NAME: task-administration
            CLIENTS_API_KEYS_0_KEY: some-secret-key
            CLIENTS_API_KEYS_0_ROLES_0: CRUD
            CLIENTS_API_KEYS_0_ROLES_1: SUBMIT
            CLIENTS_API_KEYS_1_NAME: moodle
            CLIENTS_API_KEYS_1_KEY: another-secret-key
            CLIENTS_API_KEYS_1_ROLES_0: SUBMIT
            CLIENTS_API_KEYS_2_NAME: plagiarism-checker
            CLIENTS_API_KEYS_2_KEY: key-for-reading-submissions
            CLIENTS_API_KEYS_2_ROLES_0: READ_SUBMISSION
⁠Environment Variables

In production environment, the application requires two database users:

  • A database administrator user which has the permission to create the tables.
  • A JPA user which has read/write access (SELECT, INSERT, UPDATE, DELETE, TRUNCATE) to the database tables.

In development environment, one user will be used for both by default.

The users must be configured via environment variables. The clients have to be configured via environment variables as well (X/Y stands for a 0-based index).

VariableDescription
SERVER_PORTThe server port.
SPRING_DATASOURCE_URLJDBC-URL to the database
SPRING_DATASOURCE_USERNAMEThe username of the JPA user.
SPRING_DATASOURCE_PASSWORDThe password of the JPA user.
SPRING_FLYWAY_USERThe username of the database administrator user.
SPRING_FLYWAY_PASSWORDThe password of the database administrator user.
CLIENTS_API_KEYS_X_NAMEThe name of the client.
CLIENTS_API_KEYS_X_KEYThe API key of the client.
CLIENTS_API_KEYS_X_ROLES_YThe role of the client.

Tag summary

Content type

Image

Digest

sha256:c9cbb51fc…

Size

146 MB

Last updated

about 2 years ago

docker pull etutorplusplus/task-app-binary-search