Framework for creating simple websites
PHP HTML CSS JavaScript Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
build
config
docs/api
resources
src/Inachis/CoreBundle
tests/phpunit/Inachis/CoreBundle
web
.codeclimate.yml
.coveralls.yml
.editorconfig
.gitignore
.styleci.yml
.travis.yml
Appfile
LICENSE
README.md
composer.json
gulpfile.js
package.json
phpdoc.dist.xml
phpunit.xml

README.md

Inachis Framework

TravisCI StyleCI Code Climate Coverage Status

This is currently an experimental framework - more details will be provided as additions are made available.

Installation using Composer

  • Add the jedi58/inachis package to the require section of your composer.json file.
$  composer require jedi58/inachis
  • Run composer install

If you would like to use the default templates then you will need npm and gulp so that you can then run npm install followed by gulp to build prepare the assets.

Deployment and configuration using Ansible

Environments deployed using Ansible hav etheir configuration stored in the usual YAML files. For the default passwords used by each service (MySQL, RabbitMQ, etc.) please refer to https://github.com/jedi58/inachis/blob/master/dev/ansible/vars/all.yml

For use in a production environment it is recommended that these passwords are NOT used.

Testing

Whilst this framework is still in progress the majority of it's testing is done using PHPUnit. To run these tests, from the root of your checkout you can run:

$  phpunit

You may however notice the warnings for the timezone (depending on your local PHP set-up). To avoid this it is recommended that you instead use the following:

$  ./build/run_phpunit.sh

There is also a ./check_psr2.sh script to check that the code adhere's to the PSR-2 standard. To use this you will first need to ensure PHP CodeSniffer and Beautifer are available and in your PATH. If you haven't got these, they can be quickly installed using:

$  ./build/install_phpcs.sh

Once the interface is added the test suite will be expanded to include Behat.

License

This code is released under the MIT License (MIT). Please see License File for more information.