ashtokalo / ewyii
Yii 2.0 Empty Web Application Template
Installs: 3
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 0
Type:project
Requires
- php: >=7.2.0
- vlucas/phpdotenv: ^4.1
- yiisoft/yii2: ~2.0.35
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.17@dev
This package is auto-updated.
Last update: 2024-12-10 06:37:51 UTC
README
The Yii 2.0 web application template used to rapidly start common web project with command line interface, api, frontend and backend. Backend styled with AdminLTE theme and includes interfaces to manage users, logs, errors and queues.
Installation
It's best to start with Composer and simple command like:
composer create-project --prefer-dist --stability=dev ashtokalo/ewyii example
Directory Structure
app/ contains application source code
api/ application interface
backend/ backend interface
cli/ command line interface
config/ application configurations
frontend/ frontend interface
docker/ assets to run docker environment
docs/ some documentation to run project
runtime/ files generated at runtime
tests/ a few tests to be used as examples
vendor/ 3rd-party packages
Configuration
Use file .env
or environment variables to pass sensitive data to application. See .env.dist
for example.
All tiers has it's own configuration files to extend config/common.php
, e.g. app/config/frontend.php
.
It's regular Yii configuration files.
Testing
TODO...
Contributing
It's an open source project, so any contributions are welcome. You can report an issue or contribute to the code using simple rules:
-
PSR-2 Coding Standard - Check the code style with
$ composer check-style
and fix it with$ composer fix-style
. -
Create feature branches - Don't ask me to pull from your master branch.
-
One pull request per feature - If you want to do more than one thing, send multiple pull requests.
-
Document any change in behaviour - Make sure the
README.md
and any other relevant documentation are kept up-to-date. -
Send coherent history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.
-
Add tests! - Usually your patch won't be accepted if it doesn't have tests.