IT-Planet_If_else_katagarov
Weather app
Weather app is a skeleton Yii 2 application best for rapidly creating small projects.
The template contains the basic features including user login/logout and a contact page. It includes all commonly used configurations that would allow you to focus on adding new features to your application.
DIRECTORY STRUCTURE
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
REQUIREMENTS
The minimum requirement by this project template that your Web server supports PHP 7.4.
INSTALLATION
Install via Composer
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:
composer create-project --prefer-dist yiisoft/yii2-app-basic weather
Now you should be able to access the application through the following URL, assuming
is the directory
directly under the Web root.
http://localhost/weather/
Install from an Archive File
Extract the archive file downloaded from yiiframework.com to
a directory named
that is directly under the Web root.
Set cookie validation key in
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/weather/
Install with Docker
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
Add database tables
php yii migrate
!!! Write init command
php yii hello/init
You can then access the application through the following URL:
http://127.0.0.1:8000
NOTES:
- Minimum required Docker engine version
for development (see Performance tuning for volume mounts)17.04 - The default configuration uses a host-volume in your home directory
for composer caches.docker-composer
CONFIGURATION
Database
Edit the file
with real data, for example:
return [ 'class' => 'yii\db\Connection', 'dsn' => 'pgsql:host=localhost;dbname=postgres', 'username' => '...', 'password' => '...', '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
directory to customize your application as required.config/ - Refer to the README in the
directory for information specific to basic application tests.tests
TESTING
Tests are located in
directory. They are developed with Codeception PHP Testing Framework.
By default, there are 3 test suites:
- unit
- functional
- acceptance
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.
Running acceptance tests
To execute acceptance tests do the following:
-
Rename
totests/acceptance.suite.yml.example
to enable suite configurationtests/acceptance.suite.yml -
Replace
package incodeception/base
withcomposer.json
to install full-featured version of Codeceptioncodeception/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
database and update it by applying migrations if you have them.yii2basic_testtests/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
Code coverage support
By default, code coverage is disabled in
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 --coverage-html --coverage-xml
#collect coverage only for unit tests
vendor/bin/codecept run unit --coverage --coverage-html --coverage-xml
#collect coverage for unit and functional tests
vendor/bin/codecept run functional,unit --coverage --coverage-html --coverage-xml
You can see code coverage output under the
directory.