This is an online questionaire system designed to learn more about online members. The aim is to eventually produce cards which summarise a bunch of people's different personality and skill information. This will then be used to help people work together.
Based on the Mozzler - Yii 2 Default Project Template. Yii 2 is a web application framework for rapidly creating small projects.
This version is updated with Mozzler specific changes to use that as the main framework set of editions.
The project is expected to run using MongoDB as the database and PHP using Apache or Nginx as the webserver.
When you add a new component and want the IDE autocomplete you'll want to regenerate the stubs so you can use \Yii::$app->componentName)
you can run ./yii stubs 'config/console.php' 'config/web.php'
Running the stubs command should update the vendor/Yii.php file and add a number of @property entries. CHeck https://packagist.org/packages/bazilio/yii2-stubs-generator for more info
assets/ contains assets definition
commands/ contains console commands (controllers)
config/ contains application configurations
controllers/ contains Web controller classes
mail/ contains view files for e-mails
models/ contains model classes
runtime/ contains files generated during runtime
tests/ contains various tests for the basic application
vendor/ contains dependent 3rd-party packages
views/ contains view files for the Web application
web/ contains the entry script and Web resources
The minimum requirement by this project template that your Web server supports PHP 5.4.0.
If you do not have Composer, you may install it by following the instructions at getcomposer.org.
You can then install this project template using the following command:
php composer.phar create-project --prefer-dist --stability=dev yiisoft/yii2-app-basic basic
Now you should be able to access the application through the following URL, assuming basic is the directory
directly under the Web root.
http://localhost/basic/web/
Extract the archive file downloaded from yiiframework.com to
a directory named basic that is directly under the Web root.
Set cookie validation key in config/web.php file to some random secret string:
'request' => [
// !!! insert a secret key in the following (if it is empty) - this is required by cookie validation
'cookieValidationKey' => '<secret random string goes here>',
],You can then access the application through the following URL:
http://localhost/basic/web/
Update your vendor packages
docker-compose run --rm php composer update --prefer-dist
Run the installation triggers (creating cookie validation code)
docker-compose run --rm php composer install
Start the container
docker-compose up -d
You can then access the application through the following URL:
http://127.0.0.1:8000
NOTES:
- Minimum required Docker engine version
17.04for development (see Performance tuning for volume mounts) - The default configuration uses a host-volume in your home directory
.docker-composerfor composer caches
To work with a headless virtual environment, do the following:
In the Vagrantfile alter the app domain name e.g. drivible.test, this domain is the browser accessible address
domains = {
app: 'drivible.test'
}
Update machine name in vagrant/config/vagrant-local.yml e.g. drivible and VM IP address e.g. 192.168.83.138 (so not to conflict with other VMs and connect the MongoDB via Compass)
# Virtual machine name
machine_name: drivible
# Virtual machine IP
ip: 192.168.83.138
You can also use the config file above to tailor your VM specifications based on your needs.
Edit the config/web.php e.g. drivible as app name
'name' => 'Drivible',
Change in nginx/app.conf the server_name e.g. drivible.test to match the changes in the Vagrantfile app domain
server_name drivible.test;
Then, provision the server
vagrant up
NOTES:
- Vagrant installation is not fully unattended as it may require host password before proceeding in the middle of the process, kindly be aware or it will wait until your next intervention
- Installation might take some time, for a successful process, you will be greeted with a message below, otherwise, error might occured
==> drivible: App URL: http://drivible.test
- Kindly refer to Vagrant docs to know more about vagrant commands (CLI) other than
vagrant up,vagrant halt,vagrant destroy
Edit the file config/db.php with real data, for example:
return [
'class' => 'yii\db\Connection',
'dsn' => 'mysql:host=localhost;dbname=yii2basic',
'username' => 'root',
'password' => '1234',
'charset' => 'utf8',
];NOTES:
- Yii won't create the database for you, this has to be done manually before you can access it.
- Check and edit the other files in the
config/directory to customize your application as required. - Refer to the README in the
testsdirectory for information specific to basic application tests.
Tests are located in tests directory. They are developed with Codeception PHP Testing Framework.
By default there are 3 test suites:
unitfunctionalacceptance
Tests can be executed by running
vendor/bin/codecept run
The command above will execute unit and functional tests. Unit tests are testing the system components, while functional tests are for testing user interaction. Acceptance tests are disabled by default as they require additional setup since they perform testing in real browser.
To execute acceptance tests do the following:
-
Rename
tests/acceptance.suite.yml.exampletotests/acceptance.suite.ymlto enable suite configuration -
Replace
codeception/basepackage incomposer.jsonwithcodeception/codeceptionto install full featured version of Codeception -
Update dependencies with Composer
composer update -
Download Selenium Server and launch it:
java -jar ~/selenium-server-standalone-x.xx.x.jarIn case of using Selenium Server 3.0 with Firefox browser since v48 or Google Chrome since v53 you must download GeckoDriver or ChromeDriver and launch Selenium with it:
# for Firefox java -jar -Dwebdriver.gecko.driver=~/geckodriver ~/selenium-server-standalone-3.xx.x.jar # for Google Chrome java -jar -Dwebdriver.chrome.driver=~/chromedriver ~/selenium-server-standalone-3.xx.x.jarAs an alternative way you can use already configured Docker container with older versions of Selenium and Firefox:
docker run --net=host selenium/standalone-firefox:2.53.0 -
(Optional) Create
yii2_basic_testsdatabase and update it by applying migrations if you have them.tests/bin/yii migrateThe database configuration can be found at
config/test_db.php. -
Start web server:
tests/bin/yii serve -
Now you can run all available tests
# run all available tests vendor/bin/codecept run # run acceptance tests vendor/bin/codecept run acceptance # run only unit and functional tests vendor/bin/codecept run unit,functional
By default, code coverage is disabled in codeception.yml configuration file, you should uncomment needed rows to be able
to collect code coverage. You can run your tests and collect coverage with the following command:
#collect coverage for all tests
vendor/bin/codecept run -- --coverage-html --coverage-xml
#collect coverage only for unit tests
vendor/bin/codecept run unit -- --coverage-html --coverage-xml
#collect coverage for unit and functional tests
vendor/bin/codecept run functional,unit -- --coverage-html --coverage-xml
You can see code coverage output under the tests/_output directory.
composer.json has entries in require-dev that point to development versions of mozzler related packages. This allows for easily developing in those packages with live updating within the current yii2 application. This avoids needing to update a package, commit it, then re-run composer to update.