Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/raupulus/yii2-app-basic
Yii 2.0 Basic Application Template - Modify
https://github.com/raupulus/yii2-app-basic
framwork php yii yii2 yii2-app yii2-application-template yii2-basic yii2-framework
Last synced: 3 months ago
JSON representation
Yii 2.0 Basic Application Template - Modify
- Host: GitHub
- URL: https://github.com/raupulus/yii2-app-basic
- Owner: raupulus
- License: gpl-3.0
- Archived: true
- Fork: true (yiisoft/yii2-app-basic)
- Created: 2018-03-28T17:32:29.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-06-20T15:23:35.000Z (over 6 years ago)
- Last Synced: 2024-09-23T22:04:00.875Z (3 months ago)
- Topics: framwork, php, yii, yii2, yii2-app, yii2-application-template, yii2-basic, yii2-framework
- Language: PHP
- Homepage: https://packagist.org/packages/fryntiz/yii2-app-basic#dev-master
- Size: 584 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Citation: CITATION.txt
Awesome Lists containing this project
README
#plantilla
Yii 2 Basic Project Template (mod)
This project template is based a Yii 2 Basic Project:
[Yii 2](http://www.yiiframework.com/)
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.
[](https://packagist
.org/packages/fryntiz/yii2-app-basic)
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.0.0.
INSTALLATION
------------
### Install via Composer
~~~
composer create-project fryntiz/yii2-app-basic:dev-master --no-interaction 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/
~~~
CONFIGURATION
-------------
### Database
Db directory contents structure for database, you can install this db:
```php
make db
```
**NOTES:**
You need create db first.
TESTING
-------
Tests are located in `tests` directory. They are developed with [Codeception PHP Testing Framework](http://codeception.com/).
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:
1. Rename `tests/acceptance.suite.yml.example` to `tests/acceptance.suite.yml` to enable suite configuration
2. Replace `codeception/base` package in `composer.json` with `codeception/codeception` to install full featured
version of Codeception
3. Update dependencies with Composer
```
composer update
```
4. Download [Selenium Server](http://www.seleniumhq.org/download/) and launch it:
```
java -jar ~/selenium-server-standalone-x.xx.x.jar
```
In case of using Selenium Server 3.0 with Firefox browser since v48 or Google Chrome since v53 you must download [GeckoDriver](https://github.com/mozilla/geckodriver/releases) or [ChromeDriver](https://sites.google.com/a/chromium.org/chromedriver/downloads) 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.jar
```
As 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
```
5. (Optional) Create `yii2_basic_tests` database and update it by applying migrations if you have them.
```
tests/bin/yii migrate
```
The database configuration can be found at `config/test_db.php`.
6. Start web server:
```
tests/bin/yii serve
```
7. 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 `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.