Skip to content

Latest commit

 

History

History
71 lines (46 loc) · 2.19 KB

README.md

File metadata and controls

71 lines (46 loc) · 2.19 KB
Raw

My Ichtus

Build Status Scrutinizer Code Quality   Code Coverage

Introduction

My Ichtus is a web application based on GraphQL for the API and Angular for the client.

Installation

The recommended way to get a working copy is the following:

  1. Set up a nginx virtual host to point to htdocs/ directory and to include configuration/nginx.conf
  2. Create a database in MariaDB named "my-ichtus"
  3. Configure database in config/autoload/local.php (see example config/autoload/local.php.dist)
  4. Finally, build the app:
./bin/build.sh

Development

Server

To switch the API to development (to enable logging), run:

composer development-enable

Logs will be available in logs/all.log.

Configuration caching

When in development mode, the configuration cache is disabled, and switching in and out of development mode will remove the configuration cache.

You may need to clear the configuration cache in production when deploying if you deploy to the same directory. You may do so using the following:

$ composer clear-config-cache

Client

Run yarn dev for a dev server. Navigate to http://my-ichtus.lan:4200/. The app will automatically reload if you change any of the source files.

Testing

PHPUnit

PHPUnit tests require a reference database dump. When the dump is loaded it will destroy existing database. This must be done once before running tests. Then each test is ran within a transaction which is rolled back, so the database state is always predictable.

To run PHPunit test:

./bin/load-test-data.php
./vendor/bin/phpunit # as many times as necessary

Karma

Run ng test to execute the unit tests via Karma.