README

Tailwind and Bootstrap theme setup generator for Pyrocms.

I have written this extension simply to help myself get started more quickly and in a way i prefer to have things setup myself.

If you like it you are free to use it.

How to use it

Install pyro cms

composer create-project pyrocms/pyrocms [projectname]
php artisan install

For more information, see PyroCMS documentation

Install Avviare

Add the pixney repository to your composer.

{
  "repositories": [{
    "type": "composer",
    "url": "https://packages.pixney.com"
  }]
}

Require it:

composer require "pixney/avviare-extension"
composer dump
php artisan addon:install avviare

Create a theme

Run the following command to generate the theme.

php artisan avviare:create mycompany.theme.themename

Example: pixney.theme.mytheme

SVG Spitemaps (svg-spritemap-webpack-plugin)

If you use svgs, it's a recommended to create a svg sprite. After you have run npm install you simply place your svgs in resources/svgs and when you run npm run watch/production this plugin will create the svg sprite map for you.

Using an svg within twig files

Include the spritemap in your view:

<div style="display:none">
	{% include "theme::partials/svgs" %}
</div>

To display the svg :

<svg><use xlink:href="#example" /></svg>

Use Browsersync

Within the webpack.mix.js file, set the proxy and files to watch for:

.browserSync({
    proxy: 'devsite.test',
    files: [
        'public/js/**/*.js',
        'public/css/**/*.css'
    ]
})

If you don't want to use svg sprite plugin or browsersync, simply comment out or remove the reference within webpack.mix.js

Styling

Simple styling, just remove it and make your own..

After install

Run npm install from the root directory (basepath) to install all the dependencies specified in your package.json file.

At the end run npm run watch to transpile/compile everything.

Make sure you are using the theme.

Either to to display->settings within the admin to activate your theme or in your .env file specify: STANDARD_THEME=mycompany.theme.themename

Change the Open Graph and Favicon images

Within your theme directory, you want to change the images placed within resources/images. You can change it's location as well, but if you do make sure you update metadata.twig.

pixney / avviare-extension

Maintainers

Details