korowai/framework

Framework for Korowai project

dev-master 2020-01-19 17:00 UTC

This package is auto-updated.

Last update: 2022-06-22 14:37:44 UTC


README

Build Status (TravisCI) BUild Status (CircleCI) Codecov Maintainability Documentation Status

Open Source software for exploring LDAP directories.

Why Korowai?

The Korowai, also called the Kolufo, are the people who live in southeastern West Papua in the Indonesian Province of Papua, close to the border with Papua New Guinea. The majority of the Korowai clans live in tree houses on their isolated territory.

Korowai life highly dependent on trees. Similarly, some admins' work depends on LDAP database, which has tree structure.

Online documentation

See documentation on ReadTheDocs.

Notes for users

Runtime Requirements

PHP>=7.1.3 is required. In addition to PHP, you may need to install these packages

apt-get install php-ldap php-xml php-mbstring

Notes for developers

Development requirements

Initial preparations

After you've just cloned

php bootstrap-dev && php composer install

Running unit tests

php vendor/bin/phpunit

Running integration tests

./docker-compose run --rm php-test vendor/bin/behat
./docker-compose down

Running interactive PHP shell

./docker-compose run --rm php-cli vendor/bin/psysh

Running CodeClimate

./docker-compose -f docker-compose.codeclimate.yml run --rm codeclimate analyze
./docker-compose -f docker-compose.codeclimate.yml down

Generating API documentation

./docker-compose -f docs/docker-compose.yml run --rm sami build
./docker-compose -f docs/docker-compose.yml down

The generated API docs go to docs/build/html/api/.

Generating API documentation continuously and serving via HTTP

./docker-compose -f docs/docker-compose.yml up sami
./docker-compose -f docs/docker-compose.yml down

The generated API docs go to docs/build/html/api/ and get exposed at

  • https://localhost:8001.

Generating sphinx documentation continuously

TODO:

The generated docs go to docs/build/html and get exposed at

  • http://localhost:8000.