Skip to content

Latest commit

 

History

History
341 lines (250 loc) · 8.7 KB

INSTRUCTIONS.md

File metadata and controls

341 lines (250 loc) · 8.7 KB
Raw

VaahCMS

Following are the instructions for developers only.

Tips

New Releases

  • composer.json version should match with your release via github then only it will be updated on packagist

Following details are for internal team

PR Templates:

Features: &template=feature-template.md

Releases: &template=release-template.md

Steps to Setup

Step 1) Install Package

composer require webreinvent/vaahcms

Step 2) Publish Assets

php artisan vendor:publish --provider="WebReinvent\VaahCms\VaahCmsServiceProvider" --tag=assets --force
php artisan vendor:publish --provider="WebReinvent\VaahCms\VaahCmsServiceProvider" --tag=migrations  --force
php artisan vendor:publish --provider="WebReinvent\VaahCms\VaahCmsServiceProvider" --tag=seeds --force
php artisan vendor:publish --provider="WebReinvent\VaahCms\VaahCmsServiceProvider" --tag=config --force

Step 3) Register Service Provider

Add following service provider in config/app.php

/*
 * Package Service Providers...
 */
 'providers' => [
         //...
         WebReinvent\VaahCms\VaahCmsServiceProvider::class,
         //...
     ],

Step 4) Add following in config/auth.php

'providers' => [
        //...
        'users' => [
            'driver' => 'eloquent',
            'model' => \ WebReinvent\VaahCms\Models\User::class,
        ],
        //...
    ],

Step 5) Update composer.json file

Create following folder in your laravel root folder

vaahcms/Modules
vaahcms/Themes

Add following two lines in psr-4 in composer.json

...
"autoload": {
    "files": [],
    "psr-4": {
        "App\\": "app/",
        ...
        "VaahCms\\Modules\\": "vaahcms/Modules/",
        "VaahCms\\Themes\\": "vaahcms/Themes/"
        ...
    },
    "classmap": [
        "database/seeds",
        "database/factories"
    ]
},
...

Then run following command

composer dump-autoload

Step 6) Visit <base-url>/public/vaahcms/setup:

Step 7) If you get Numeric value out of range error then you can fix it by adding following code in App\Providers\AppServiceProvider.php

public function boot()
{
    Schema::defaultStringLength(191);
}

Commands

Run queue

php artisan queue:work --queue=high,medium,low,default --env=pradeep

How to dispatch job:

dispatch((new ProcessNotifications($notification, $user, $inputs))
            ->onQueue('high'));

How to set jobs where you can track progress? Answer: Batches

$batch = Bus::batch([])->onQueue('high')->dispatch();
$batch->add(new ProcessNotifications($notification, $user, $inputs));

Publish All Assets

php artisan vendor:publish --provider="WebReinvent\VaahCms\VaahCmsServiceProvider"

Publish All Configuration

php artisan vendor:publish --provider="WebReinvent\VaahCms\VaahCmsServiceProvider" --tag=config

Publish Languages

php artisan vendor:publish --provider="WebReinvent\VaahCms\VaahCmsServiceProvider" --tag=lang

Publish Views

php artisan vendor:publish --provider="WebReinvent\VaahCms\VaahCmsServiceProvider" --tag=views

Publish Migrations

php artisan vendor:publish --provider="WebReinvent\VaahCms\VaahCmsServiceProvider" --tag=migrations

Publish Seeds

php artisan vendor:publish --provider="WebReinvent\VaahCms\VaahCmsServiceProvider" --tag=seeds

Publish Assets

php artisan vendor:publish --provider="WebReinvent\VaahCms\VaahCmsServiceProvider" --tag=assets

Create migrations

php artisan make:migration create_vh_users_table --path=/packages/vaahcms/Database/Migrations

Create seeds

php artisan make:seeder PermissionsTableSeeder --path=/packages/vaahcms/Database/Seeders
php artisan make:seeder RolesTableSeeder --path=/packages/vaahcms/Database/Seeders
php artisan make:command HealthcheckCommand --path=/packages/vaahcms/Database/Seeders

Manual upgrade of VaahCMS

  • php artisan vendor:publish --provider="WebReinvent\VaahCms\VaahCmsServiceProvider" --tag=assets --force
  • php artisan vendor:publish --provider="WebReinvent\VaahCms\VaahCmsServiceProvider" --tag=migrations --force
  • php artisan vendor:publish --provider="WebReinvent\VaahCms\VaahCmsServiceProvider" --tag=seeds --force
  • php artisan migrate --force
  • php artisan db:seed --force

Minify Assets of Admin with Laravel Mix

Install following package

npm install --save-dev fs

Replace the content of webpack.mix.fs

var admin_path = 'resources/assets/vendor/vaahcms/admin/';
var admin_default_theme_path = admin_path+'default/';

mix.setPublicPath(admin_default_theme_path);

var admin_assets_json = JSON.parse(fs.readFileSync(admin_default_theme_path+'assets.json'));

//console.log(admin_assets_json);

var admin_copy_path = './resources/assets/vendor/vaahcms/admin/';
var admin_copy_path_des = './packages/vaahcms/src/Resources/assets/admin/';

fs_extra.removeSync(admin_copy_path_des);

mix.combine(admin_assets_json['css'], admin_default_theme_path+'builds/vaahcms.css')
    .combine(admin_assets_json['js'], admin_default_theme_path+'builds/vaahcms.js')
    .js(admin_default_theme_path+'vue/app-setup.js',  './builds')
    .js(admin_default_theme_path+'vue/app-dashboard.js',  './builds')
    .js(admin_default_theme_path+'vue/app-modules.js',  './builds')
    .copyDirectory(admin_copy_path, admin_copy_path_des, false)
    .version();


//mix.copyDirectory(admin_copy_path, admin_copy_path_des, false);


mix.webpackConfig({
    watchOptions: {
        aggregateTimeout: 2000,
        poll: 20,
        ignored: [
            '/app/',
            '/bootstrap/',
            '/config/',
            '/database/',
            '/packages/',
            '/public/',
            '/routes/',
            '/storage/',
            '/tests/',
            '/vaahcms/',
            '/node_modules/',
            '/vendor/',

        ]
    }
});

How to Setup Laravel Dusk on Windows

  • Step 1) Install composer require --dev laravel/dusk

  • Step 2) Run php artisan dusk:install

  • Step 3) Download chromdriver from https://sites.google.com/a/chromium.org/chromedriver/downloads

  • Step 4) Unzip and open chromedriver.exe and keep it running.

  • Step 5) To do browser based test, open file tests/DuskTestCase.php and comment static::startChromeDriver();

  • Step 6) In tests/DuskTestCase.php file comment '--headless',:

...
$options = (new ChromeOptions)->addArguments([
            '--disable-gpu',
            //'--headless', <-- comment this line
            '--window-size=1920,1080',
        ]);
...

  • Step 7) Make sure your APP_URL in .env is as per the the xampp or actual application url

  • Step 8) Run php artisan dusk, it may show Warning: TTY mode is not supported on Windows platform. error you can ignore this error. If it run successfully, it will will open chrome and run your tests.

  • Step 9) Install composer require beyondcode/dusk-dashboard --dev

  • Step 10) Run php artisan dusk:dashboard

Create Tests for VaahCms Modules:

  • Change path of dusk in phpunit.dusk.xml to following:
...
<directory suffix="Test.php">./VaahCms/Modules/<module_name>/Tests/Browser</directory>
...

How to make a release

  • Create a release branch from Gitflow from GitKrane
  • Update version in composer.json and config\vaahcms.php
  • Run npm run production to generate new assets
  • Commit the changes to git
  • Finish the release branch, this will merge to the code to master branch
  • Run auto-changelog --template changelog-template.hbs --commit-limit false to generate CHANGELOG.MD file
  • Commit and push changes
  • Visit https://github.com/webreinvent/vaahcms/releases and click on Draft a new release
  • Enter the latest version in Tag version & Release title and changes log in description.

Tools

Tutorials

Update Packagist with GitHub Webhooks

  • As the PayLoad URL type in: Visit: https://packagist.org/profile/ and get the API Token and
https://packagist.org/api/github?username=PACKAGIST_USERNAME
  • Go to your GitHub repository and select Settings -> WebHooks -> Add Webhook
  • In Payload URL enter the packagist url
  • In Content type choose application/json
  • In Secrete add API Token
  • Choose Let me select individual events. and select Pushes
  • Click on Save

For running composer update:

$process = new Process('cd .. && php artisan dusk --group=bkkrishna');
$process->setPTY(true);
$process->run();

Changelog Command:

auto-changelog --commit-limit false --template changelog-template.hbs