{"id":15169516,"url":"https://github.com/peulearning/sample-project","last_synced_at":"2026-02-23T13:33:50.428Z","repository":{"id":247602588,"uuid":"826324571","full_name":"peulearning/sample-project","owner":"peulearning","description":"Sample of a project to test a school grant.","archived":false,"fork":false,"pushed_at":"2024-07-09T13:43:55.000Z","size":64,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-14T06:35:57.499Z","etag":null,"topics":["framework","php","website","yii2"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/peulearning.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"open_collective":"yiisoft","tidelift":"packagist/yiisoft/yii2-app-basic"}},"created_at":"2024-07-09T13:40:49.000Z","updated_at":"2024-07-09T13:45:04.000Z","dependencies_parsed_at":"2024-07-09T17:41:43.906Z","dependency_job_id":null,"html_url":"https://github.com/peulearning/sample-project","commit_stats":null,"previous_names":["peulearning/sample-project"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/peulearning/sample-project","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peulearning%2Fsample-project","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peulearning%2Fsample-project/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peulearning%2Fsample-project/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peulearning%2Fsample-project/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/peulearning","download_url":"https://codeload.github.com/peulearning/sample-project/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peulearning%2Fsample-project/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29743852,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-23T07:44:07.782Z","status":"ssl_error","status_checked_at":"2026-02-23T07:44:07.432Z","response_time":90,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["framework","php","website","yii2"],"created_at":"2024-09-27T07:03:04.301Z","updated_at":"2026-02-23T13:33:50.398Z","avatar_url":"https://github.com/peulearning.png","language":"PHP","readme":"\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/yiisoft\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://avatars0.githubusercontent.com/u/993323\" height=\"100px\"\u003e\n    \u003c/a\u003e\n    \u003ch1 align=\"center\"\u003eYii 2 Basic Project Template\u003c/h1\u003e\n    \u003cbr\u003e\n\u003c/p\u003e\n\nYii 2 Basic Project Template is a skeleton [Yii 2](https://www.yiiframework.com/) application best for\nrapidly creating small projects.\n\nThe template contains the basic features including user login/logout and a contact page.\nIt includes all commonly used configurations that would allow you to focus on adding new\nfeatures to your application.\n\n[![Latest Stable Version](https://img.shields.io/packagist/v/yiisoft/yii2-app-basic.svg)](https://packagist.org/packages/yiisoft/yii2-app-basic)\n[![Total Downloads](https://img.shields.io/packagist/dt/yiisoft/yii2-app-basic.svg)](https://packagist.org/packages/yiisoft/yii2-app-basic)\n[![build](https://github.com/yiisoft/yii2-app-basic/workflows/build/badge.svg)](https://github.com/yiisoft/yii2-app-basic/actions?query=workflow%3Abuild)\n\nDIRECTORY STRUCTURE\n-------------------\n\n      assets/             contains assets definition\n      commands/           contains console commands (controllers)\n      config/             contains application configurations\n      controllers/        contains Web controller classes\n      mail/               contains view files for e-mails\n      models/             contains model classes\n      runtime/            contains files generated during runtime\n      tests/              contains various tests for the basic application\n      vendor/             contains dependent 3rd-party packages\n      views/              contains view files for the Web application\n      web/                contains the entry script and Web resources\n\n\n\nREQUIREMENTS\n------------\n\nThe minimum requirement by this project template that your Web server supports PHP 7.4.\n\n\nINSTALLATION\n------------\n\n### Install via Composer\n\nIf you do not have [Composer](https://getcomposer.org/), you may install it by following the instructions\nat [getcomposer.org](https://getcomposer.org/doc/00-intro.md#installation-nix).\n\nYou can then install this project template using the following command:\n\n~~~\ncomposer create-project --prefer-dist yiisoft/yii2-app-basic basic\n~~~\n\nNow you should be able to access the application through the following URL, assuming `basic` is the directory\ndirectly under the Web root.\n\n~~~\nhttp://localhost/basic/web/\n~~~\n\n### Install from an Archive File\n\nExtract the archive file downloaded from [yiiframework.com](https://www.yiiframework.com/download/) to\na directory named `basic` that is directly under the Web root.\n\nSet cookie validation key in `config/web.php` file to some random secret string:\n\n```php\n'request' =\u003e [\n    // !!! insert a secret key in the following (if it is empty) - this is required by cookie validation\n    'cookieValidationKey' =\u003e '\u003csecret random string goes here\u003e',\n],\n```\n\nYou can then access the application through the following URL:\n\n~~~\nhttp://localhost/basic/web/\n~~~\n\n\n### Install with Docker\n\nUpdate your vendor packages\n\n    docker-compose run --rm php composer update --prefer-dist\n    \nRun the installation triggers (creating cookie validation code)\n\n    docker-compose run --rm php composer install    \n    \nStart the container\n\n    docker-compose up -d\n    \nYou can then access the application through the following URL:\n\n    http://127.0.0.1:8000\n\n**NOTES:** \n- Minimum required Docker engine version `17.04` for development (see [Performance tuning for volume mounts](https://docs.docker.com/docker-for-mac/osxfs-caching/))\n- The default configuration uses a host-volume in your home directory `.docker-composer` for composer caches\n\n\nCONFIGURATION\n-------------\n\n### Database\n\nEdit the file `config/db.php` with real data, for example:\n\n```php\nreturn [\n    'class' =\u003e 'yii\\db\\Connection',\n    'dsn' =\u003e 'mysql:host=localhost;dbname=yii2basic',\n    'username' =\u003e 'root',\n    'password' =\u003e '1234',\n    'charset' =\u003e 'utf8',\n];\n```\n\n**NOTES:**\n- Yii won't create the database for you, this has to be done manually before you can access it.\n- Check and edit the other files in the `config/` directory to customize your application as required.\n- Refer to the README in the `tests` directory for information specific to basic application tests.\n\n\nTESTING\n-------\n\nTests are located in `tests` directory. They are developed with [Codeception PHP Testing Framework](https://codeception.com/).\nBy default, there are 3 test suites:\n\n- `unit`\n- `functional`\n- `acceptance`\n\nTests can be executed by running\n\n```\nvendor/bin/codecept run\n```\n\nThe command above will execute unit and functional tests. Unit tests are testing the system components, while functional\ntests are for testing user interaction. Acceptance tests are disabled by default as they require additional setup since\nthey perform testing in real browser. \n\n\n### Running  acceptance tests\n\nTo execute acceptance tests do the following:  \n\n1. Rename `tests/acceptance.suite.yml.example` to `tests/acceptance.suite.yml` to enable suite configuration\n\n2. Replace `codeception/base` package in `composer.json` with `codeception/codeception` to install full-featured\n   version of Codeception\n\n3. Update dependencies with Composer \n\n    ```\n    composer update  \n    ```\n\n4. Download [Selenium Server](https://www.seleniumhq.org/download/) and launch it:\n\n    ```\n    java -jar ~/selenium-server-standalone-x.xx.x.jar\n    ```\n\n    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:\n\n    ```\n    # for Firefox\n    java -jar -Dwebdriver.gecko.driver=~/geckodriver ~/selenium-server-standalone-3.xx.x.jar\n    \n    # for Google Chrome\n    java -jar -Dwebdriver.chrome.driver=~/chromedriver ~/selenium-server-standalone-3.xx.x.jar\n    ``` \n    \n    As an alternative way you can use already configured Docker container with older versions of Selenium and Firefox:\n    \n    ```\n    docker run --net=host selenium/standalone-firefox:2.53.0\n    ```\n\n5. (Optional) Create `yii2basic_test` database and update it by applying migrations if you have them.\n\n   ```\n   tests/bin/yii migrate\n   ```\n\n   The database configuration can be found at `config/test_db.php`.\n\n\n6. Start web server:\n\n    ```\n    tests/bin/yii serve\n    ```\n\n7. Now you can run all available tests\n\n   ```\n   # run all available tests\n   vendor/bin/codecept run\n\n   # run acceptance tests\n   vendor/bin/codecept run acceptance\n\n   # run only unit and functional tests\n   vendor/bin/codecept run unit,functional\n   ```\n\n### Code coverage support\n\nBy default, code coverage is disabled in `codeception.yml` configuration file, you should uncomment needed rows to be able\nto collect code coverage. You can run your tests and collect coverage with the following command:\n\n```\n#collect coverage for all tests\nvendor/bin/codecept run --coverage --coverage-html --coverage-xml\n\n#collect coverage only for unit tests\nvendor/bin/codecept run unit --coverage --coverage-html --coverage-xml\n\n#collect coverage for unit and functional tests\nvendor/bin/codecept run functional,unit --coverage --coverage-html --coverage-xml\n```\n\nYou can see code coverage output under the `tests/_output` directory.\n","funding_links":["https://opencollective.com/yiisoft","https://tidelift.com/funding/github/packagist/yiisoft/yii2-app-basic"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeulearning%2Fsample-project","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpeulearning%2Fsample-project","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeulearning%2Fsample-project/lists"}