README

Features

Create modern portfolio websites in a few minutes. This LUYA CMS Kickstarter provides a highly flexible content block wich lets you define styles, colors, size, animations and much more from the admin area.

This project ist still under development

Complete LUYA CMS integration
Fully responsive and ready to use
Highly customizable content styles
Gallery with different styles and lightbox support
Full admin integration
Customizable blocks with drag 'n' drop support
SCSS and Gulp workflow for compiling
Multi level navigation included

Installation

1.) Create project with composer, fork or clone repository from Github

Creating a new project from packagist is recommend.

composer create-project dev7ch/story

Or you can also clone the git repository into your web root folder.

git clone git@github.com:dev7ch/story.git story

Navigate to the new created project root and run composer install.

composer install

Find more detailed informations and help at LUYA CMS Install Guide.

2.) Rename distributed config files and create database

Navigate from your project root into the configs/ folder.

cd configs 

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

Create a new, empty database and make sure that in configs/env-local-db.php the user and password for the database connection is properly set.

Rename example database in configs folder (optionally):

cp luya_story_demo.sql.dist luya_story_demo.sql

Import luya_story_demo.sql into your previously created database.

Of course you can start without a demo DB but it helps to see and understand the features of this theme.

3.) Run LUYA CMS setup

As all went fine navigate back to your project root and run the LUYA CMS setup commands.

cd ..

./vendor/bin/luya migrate
./vendor/bin/luya import

You could check the health of the cms system like this:

./vendor/bin/luya health

Finally adding a new admin user to your cms is required to log in to the admin interface.

If you imported luya_story_demo.sql use:

./vendor/bin/luya admin/setup/user

If you started with an empty database simply run:

./vendor/bin/luya admin/setup

Please have a look at the Luya Guide if you have any problems.

4.) Done! Login to your new Website

Congratulations, head over to your new website.

http://< your webroot >/story/public_html
http://< your webroot >/story/public_html/admin

Front-End

STORY is a modern, fully responsive theme designed by HTML5 UP.

Libraries

These frontend libraries are included and available.

» jQuery (yii\web\JqueryAsset)
» Fontawesome Icons
» Skell Responsive Framework

Compiling

We have created our own NPM Package that includes our gulp workflow.
Inside the resources/ folder, everything is prepared.

cd resources

npm install 
npm install gulp

See zephir/zephir-gulp-workflow for a full documentation of the workflow.

Backend

Assets

To speed up your local development you can uncomment the following lines in configs/env-local.php in order to use symlinking your assets instead of copy them every run.

'assetManager' => [
    'class' => 'luya\web\AssetManager',
    'linkAssets' => true,
],

Now all assets will be symlinked and not copied.

This will also enable CSS instant reload provided by browserSync (gulp).

dev7ch / story

Maintainers

Details