node package manager
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

communitytemplate

communityTemplate

Latest Version on Packagist Software License Build Status Coverage Status Quality Score Total Downloads

This is the template components and style package for the communities. Please follow this guide.

Structure

If any of the following are applicable to your project, then the directory structure should follow industry best practices by being named the following.

src/
src/assets
src/views

Install

Via Composer

$ composer require communities/communityTemplate

Usage

This package loads all views and styles in the project.

You can add a view in blade by

@include(template::components.avatar, [config])

To load the styles you have to install everything first:

php artisan template:install

NEVER edit styles of this package in the published vendor directory, because an update will overwrite those styles.

Copy the _settings.scss and settings directory to your main css directory and add them to your app.scss. After the settings, load the styles into your app.scss. Edit the settings to reflect the community needs.

@import "settings"; // Global variables, site-wide settings, config switches, etc.
@import "../vendor/templates/sass/app.scss";

TODO

  • Readme for javascript items/packages

Change log

Please see CHANGELOG for more information on what has changed recently.

Credits