Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/acdh-oeaw/dhcr-api

https://github.com/acdh-oeaw/dhcr-api

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (9.3%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: acdh-oeaw
  • License: apache-2.0
  • Language: PHP
  • Default Branch: API_v2
  • Size: 1.22 MB
Statistics
  • Stars: 0
  • Watchers: 6
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created about 4 years ago · Last pushed 10 months ago
Metadata Files
Readme License

README.md

DHCR-API

REST-ful API for the Digital Humanities Course Registry

API Documentation on SwaggerHub

https://app.swaggerhub.com/apis/hashmich/DHCR-API/1.2

Setup

The project is build using composer. See instructions on how to install composer and CakePhp specific instructions here: https://book.cakephp.org/3.0/en/installation.html

After downloading/cloning the repository, run bash php composer.phar update

If not present, create directories logs and tmp: <installation_directory> | |__logs | |__tmp | |__...

Run following command to make them writable: bash HTTPDUSER=`ps aux | grep -E '[a]pache|[h]ttpd|[_]www|[w]ww-data|[n]ginx' | grep -v root | head -1 | cut -d\ -f1` setfacl -R -m u:${HTTPDUSER}:rwx tmp setfacl -R -d -m u:${HTTPDUSER}:rwx tmp setfacl -R -m u:${HTTPDUSER}:rwx logs setfacl -R -d -m u:${HTTPDUSER}:rwx logs

Database

You'll require a dump from the production database. CakePhp connects to most SQL dialects, either MySQL, Postgres, MariaDB etc.

Configuration

The application reads all configuration constants from environment variables present on the system or docker container. Each partial app (Front-End, Back-End, API) can be run standing alone without the environment variables being present, eg. for local development. The required settings are then exported on runtime from an .env file present in the applications config directory. Overriding any already present environmental configuration from local file is prohibited, if the variable DHCR_ENV is present and TRUE.

To connect to databases, provide required access keys, set debug level or interconnect the, use the .env.default file as a template. <installation_directory> | |__config | |__.env.default

Make sure the file's contents are interpreted on container startup globally or use the renamed local file for development: <installation_directory> | |__config | |__.env

Owner

  • Name: Austrian Centre for Digital Humanities & Cultural Heritage
  • Login: acdh-oeaw
  • Kind: organization
  • Email: acdh@oeaw.ac.at
  • Location: Vienna, Austria

GitHub Events

Total
  • Push event: 12
Last Year
  • Push event: 12

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Dependencies

composer.json packagist
  • cakephp/bake ^1.9.0 development
  • cakephp/cakephp-codesniffer ^3.0 development
  • cakephp/debug_kit ^3.17.0 development
  • josegonzalez/dotenv 3.* development
  • phpunit/phpunit ^5.7|^6.0 development
  • psy/psysh @stable development
  • cakephp/cakephp ^3.7
  • cakephp/migrations ^2.0.0
  • cakephp/plugin-installer ^1.0
  • jeremyharris/cakephp-lazyload ^2.1
  • mobiledetect/mobiledetectlib 2.*
  • php >=7.0
composer.lock packagist
  • ajgl/breakpoint-twig-extension 0.3.4 development
  • aptoma/twig-markdown 2.0.0 development
  • asm89/twig-cache-extension 1.4.0 development
  • cakephp/bake 1.12.0 development
  • cakephp/cakephp-codesniffer 3.3.0 development
  • cakephp/debug_kit 3.22.4 development
  • composer/ca-bundle 1.2.8 development
  • composer/composer 1.10.16 development
  • composer/semver 1.7.1 development
  • composer/spdx-licenses 1.5.4 development
  • composer/xdebug-handler 1.4.4 development
  • dnoegel/php-xdg-base-dir v0.1.1 development
  • doctrine/instantiator 1.3.1 development
  • jasny/twig-extensions v1.2.0 development
  • jdorn/sql-formatter v1.2.17 development
  • josegonzalez/dotenv 3.2.0 development
  • justinrainbow/json-schema 5.2.10 development
  • m1/env 2.2.0 development
  • myclabs/deep-copy 1.10.1 development
  • nikic/php-parser v4.10.2 development
  • phar-io/manifest 1.0.1 development
  • phar-io/version 1.0.1 development
  • phpdocumentor/reflection-common 2.2.0 development
  • phpdocumentor/reflection-docblock 5.2.2 development
  • phpdocumentor/type-resolver 1.4.0 development
  • phpspec/prophecy v1.10.3 development
  • phpunit/php-code-coverage 5.3.2 development
  • phpunit/php-file-iterator 1.4.5 development
  • phpunit/php-text-template 1.2.1 development
  • phpunit/php-timer 1.0.9 development
  • phpunit/php-token-stream 2.0.2 development
  • phpunit/phpunit 6.5.14 development
  • phpunit/phpunit-mock-objects 5.0.10 development
  • psy/psysh v0.10.4 development
  • sebastian/code-unit-reverse-lookup 1.0.1 development
  • sebastian/comparator 2.1.3 development
  • sebastian/diff 2.0.1 development
  • sebastian/environment 3.1.0 development
  • sebastian/exporter 3.1.2 development
  • sebastian/global-state 2.0.0 development
  • sebastian/object-enumerator 3.0.3 development
  • sebastian/object-reflector 1.1.1 development
  • sebastian/recursion-context 3.0.0 development
  • sebastian/resource-operations 1.0.0 development
  • sebastian/version 2.0.1 development
  • seld/jsonlint 1.8.2 development
  • seld/phar-utils 1.1.1 development
  • squizlabs/php_codesniffer 3.5.8 development
  • symfony/finder v5.1.8 development
  • symfony/process v5.1.8 development
  • symfony/var-dumper v5.1.8 development
  • theseer/tokenizer 1.2.0 development
  • twig/twig v1.44.1 development
  • umpirsky/twig-php-function v0.1 development
  • webmozart/assert 1.9.1 development
  • wyrihaximus/twig-view 4.3.8 development
  • aura/intl 3.0.0
  • cakephp/cakephp 3.9.3
  • cakephp/chronos 1.3.0
  • cakephp/migrations 2.4.2
  • cakephp/plugin-installer 1.3.1
  • jeremyharris/cakephp-lazyload 2.1.0
  • laminas/laminas-diactoros 1.8.7p2
  • laminas/laminas-zendframework-bridge 1.1.1
  • mobiledetect/mobiledetectlib 2.8.34
  • paragonie/random_compat v9.99.99
  • psr/container 1.0.0
  • psr/http-message 1.0.1
  • psr/log 1.1.3
  • psr/simple-cache 1.0.1
  • robmorgan/phinx 0.11.7
  • symfony/config v5.1.8
  • symfony/console v5.1.8
  • symfony/deprecation-contracts v2.2.0
  • symfony/filesystem v5.1.8
  • symfony/polyfill-ctype v1.20.0
  • symfony/polyfill-intl-grapheme v1.20.0
  • symfony/polyfill-intl-normalizer v1.20.0
  • symfony/polyfill-mbstring v1.20.0
  • symfony/polyfill-php73 v1.20.0
  • symfony/polyfill-php80 v1.20.0
  • symfony/service-contracts v2.2.0
  • symfony/string v5.1.8
  • symfony/yaml v5.1.8