Skip to content

Latest commit

 

History

History
161 lines (114 loc) · 6.09 KB

INSTALL.md

File metadata and controls

161 lines (114 loc) · 6.09 KB
Raw

Installation

Русская версия

Please read through our Contribution Guidelines.

Website

Using Docker (easy way)

  • Copy file config/params.dist.php to config/params.php.
  • Copy file config/web-local.dist.php to config/web-local.php.
  • Copy file .env.docker.dist to .env.
  • Install Docker.
  • Run docker-compose up -d.
  • Run docker-compose exec php composer install.
  • Run docker-compose exec php ./yii migrate.
    • Problem (Windows): /usr/bin/env: 'php\r': No such file or directory.
      • Solution: clone the repository with the key --config core.autocrlf=input.

The website can be accessed at http://localhost:8000.

Adminer can be accessed at http://localhost:8080.

Without Docker (advanced way)

  • Copy file config/params.dist.php to config/params.php.
  • Copy file config/web-local.dist.php to config/web-local.php.
  • Copy file .env.dist to .env.
  • Set correct values in .env file for your environment.
  • Install MySQL 8.X:
    • Create a new MySQL InnoDB database ("opensourcewebsite" by default), with "utf8mb4_0900_ai_ci" collation for your environment.
    • Disable sql_mode=ONLY_FULL_GROUP_BY.
  • Install Nginx web server or Apache web server:
    • Setup your web server root folder to web.
  • Install PHP 7.4.X.
  • Install XDebug.
  • Install Composer.
  • Run php composer.phar install.
  • Run php yii migrate.

Fixtures

Fixtures are used to load a "fake" set of data into a database that can then be used for testing or to help give you some interesting data while you're developing your application.

After loading fixtures, will be available this user login credentials.

Attention! When loading fixtures, all current records from the database will be deleted!

Loading fixtures:

php yii fixture/load "*"

Unloading fixtures:

php yii fixture/unload "*"

Data Generator

The generation controller extends from \yii\console\controllers\FixtureController. So this part of documentation - Loading fixtures - can be used to understand command syntax.

New generators for models can be added to the folder modules\dataGenerator\components\generators.

Show help information:

php yii dataGenerator/default/load -h

Usage

Generates all available models with a delay of 2 seconds:

php yii dataGenerator "*"

Generates 5 User and 5 Contact models:

php yii dataGenerator "User, Contact" --limit=5

Generates User and Contact models with a delay of 5 seconds:

php yii dataGenerator "User, Contact" --interval=5

Generates all models except Contact with a delay of 5 seconds:

php yii dataGenerator "*, -Contact" --interval=5

Debug

Tips

See available debug data at localhost:8000/debug/. (If you use docker you have to change this line in config/web.php).

Use shortcut methods for logging messages of various severity levels via the Yii class:

You can see logs in runtime/logs/web.log, or at http://localhost:8000/debug/default/view?panel=log.

To enable step debugging via Xdebug in your IDE or editor of choice you should:

  1. Set several environment variables in .env file as follows:

    PHP_ENABLE_XDEBUG=1
XDEBUG_CONFIG="client_host=172.17.0.1 client_port=9005 start_with_request=yes idekey=PHPSTORM log_level=1 log=/app/xdebug.log remote_enable=true remote_autostart=true discover_client_host=true remote_log=/app/remote.xdebug.log"
XDEBUG_MODE=develop,debug

  2. Set debug port for Xdebug in your IDE to 9005. (Follow File | Settings | PHP | Debug for PHPStorm).

  3. Start docker-compose up -d.

P.S. Tested in PHPStorm only.

Tests

Setup

  • Copy file .env.test.dist to .env.test
  • Set correct values in .env.test file for test environment
  • Create a new MySQL InnoDB database ("opensourcewebsite_test" by default) with an "utf8mb4_0900_ai_ci" collation for test environment

Usage

  • Run php tests/bin/yii migrate
  • Run php vendor/bin/codecept run or php vendor/bin/codecept run --coverage --coverage-xml --coverage-html

Telegram bot

Telegram Bot API:

We recommend use ngrok - secure introspectable tunnels to localhost, for local development and testing of Telegram bots. Telegram webhooks require your public URL with HTTPS. ngrok is a tool that exposes your local environment to the world.

Also, you can use Localtunnel and Cloudflare Tunnel to receive Telegram webhooks by your local server.

  • Use Telegram BotFather to create a new bot and get a bot token.
    • Go to "Bot Settings > Group Admin Rights" and activate all rights for your bot.
    • Go to "Bot Settings > Channel Admin Rights" and activate all rights for your bot.
  • Set ['baseUrl'] in config/params.php for your public URL with HTTPS.
  • In case of connection problems to Telegram, use free anonymous proxy (list 1, list 2) to set ['bot']['proxy'] in config/params.php.
  • Set ['bot']['username'] and ['bot']['token'] in config/params.php for your bot.

Enable Telegram webhook for the bot:

php yii telegram-bot/enable-webhook

Disable Telegram webhook for the bot:

php yii telegram-bot/disable-webhook