trk/luya-uikit-kickstarter

The uikit kickstarter project for a new LUYA application (use only uikit content blocks).

dev-master / 1.0.x-dev 2018-08-13 17:54 UTC

Requires

• ext-json: *
• luyadev/luya-core: dev-master
• luyadev/luya-module-admin: dev-master
• luyadev/luya-module-cms: dev-master
• trk/luya-theme: dev-master
• trk/luya-uikit: dev-master

Requires (Dev)

• luyadev/luya-testsuite: ~1.0.0
• yiisoft/yii2-debug: ~2.0.0
• yiisoft/yii2-gii: ~2.0.0

MIT

README

LUYA Uikit 3 Kickstarter Application

Installation

First of all it´s mandatory to install the global fxp/composer-asset-plugin plugin, which is required by Yii to install bower packages via composer. To install the fxp/composer-asset-plugin globally open your terminal and run the following command:

composer global require "fxp/composer-asset-plugin:~1.4"

After setting up Composer, we execute the Composer command create-project to checkout the luya-uikit-kickstarter application, an out of the box LUYA setup to run your website directly. It´s recommend to run the create-project command directly from your htdocs/webserver folder like this:

composer create-project trk/luya-uikit-kickstarter:dev-master

Note: During the installation Composer may ask for your Github login credentials. This is normal because Composer needs to get enough API rate-limit to retrieve the dependent package information from Github. For more details, please refer to the Composer documentation.

The create-project command will create a folder (inside of your current folder where the composer create-project command was executed) named luya-uikit-kickstarter. If the Composer installation is done change into the configs folder inside the application and copy the .dist template files to original .php files.

cp env.php.dist env.php
cp env-local.php.dist env-local.php

Now the database connection inside the configs/env-local.php file needs to fit your mysql servers configuration. It´s recommend to open all config files once to change values and understand the behavior. In order to understand the config files read more in the environment configs section. After successfully setting up your database connection, you have to reopen your terminal and change into your project directory and excute the luya binary files which has been installed into your vendor folder by composer as described in the follwing.

Run the migration files with the migrate console command:

Note: If the migration process failed, try to replace localhost with 127.0.0.1 in the database DNS configuration (env-local.php) which is located in the configs folder.

./luya migrate

Build and import all filesystem configurations into the database with the import console command:

./luya import

Finally execute the setup console command command which is going to setup a user, group and permissions:

./luya admin/setup

The setup process will ask you for an email and password to store your personal login data inside the database (of course the password will be encrypted).

./luya health will make a small check if several directories exist and readable/writable.

You can now log in into the administration interface, e.g. http://localhost/luya-uikit-kickstarter/public_html/admin (dependings on the location of the LUYA files).

Visit the Installation Problems and Questions Site when you have any problems with the LUYA setup.

Base installation guide

Theme Compiling

We have created our own NPM Package that includes our gulp workflow.
Everything is prepared inside the resources/theme folder.