Skip to content

xoopscube-themes/xcl-html5-boilerplate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 

Repository files navigation

Project Status: Active – The project has reached a stable, usable state and is being actively developed. License GPL X-Updare Store

///// — XCL HTML5 Boilerplate

XCL Theme HTML5 Boilerplate


XLAYOUT xcl-html5-boilerplate
Description Starter Theme built with HTML5 Boilerplate v8.0.0 and XLayout Flexbox Helper
Render Engine Smarty v2 and Smarty v3
Version 2.3.1
Author https://github.com/h5bp/html5-boilerplate
Author @gigamaster Nuno Luciano (XCL23)
Copyright 2011-2022 Authors
License MIT
💻 The Minimum Requirements
      Apache, Nginx, etc. PHP 7.2.x
      MySQL 5.6, MariaDB  InnoDB utf8 / utf8mb4
      XCL version >= 2.3.1

Overview

HTML5-Boilerplate is a professional front-end template for building fast, robust, and adaptable web apps or sites.

Render Engine - Smarty is a template engine for PHP, facilitating the separation of presentation (HTML/CSS) from application logic.
This implies that PHP code is application logic, and is separated from the presentation, making it easier to customize theme and templates.

What is Smarty v2
Smarty 3 Overview

Features

  • Flexbox layout
  • Responsive theme
  • CSS Custom properties
  • Localization

Install or Update Themes

  1. Select a branch from this repo and, from the dropdown button "Code" select Clone or Download zip.
  2. Extract and upload the folder "theme-name" to your domain, eg.: public/html/themes/theme-name/.
  3. From the Administration dashboard, activate the Theme (checkbox/select).

User-friendly installation

X-Update Store

  1. Login to your the Administration Control Panel » X-Update » Themes
  2. Select the theme from the Theme Store
  3. Proceed to automatically download and install.

Feature Branch Workflow

Branches are used to build independent Themes, Templates, Components and features.
Following the core idea behind the Feature Branch Workflow each theme development
takes place in a dedicated branch instead of the main branch. This encapsulation makes
it easy for multiple themes built with a specific CSS framework or xLayout.

1 - Clone the repository

You can clone the repository to create a local copy on your computer.
This gives us access to all branches in this repository.

git clone https://github.com/xoopscube-themes/xcl-html5-boilerplate.git

When you clone a repository, you get the main branch by default.
This means you will have to checkout another branch yourself.
You can easily switch between each branch using GitHub Desktop.

2 - Clone a Specific Branch

There are two ways to clone a specific branch. You can either:

a) Clone the repository, fetch all branches, and checkout a specific branch. b) Clone the repository and fetch only a single branch.

Option One

git clone --branch <branchname> <remote-repo-url>

or using -b an alias for --branch

git clone -b <branchname> <remote-repo-url>

Option Two

git clone --branch <branch-theme-name> --single-branch <remote-repo-url>

or using -b an alias for --branch

git clone -b <branch-theme-name> --single-branch <remote-repo-url>

This performs the same action as option one, except that the --single-branch option
only fetch the files from the specified Theme branch without fetching other branches.

Learn more...

Theme Folder Structure

Technically, themes only require four files : manifesto.ini.php, screenshot.png, style.css, theme.html.
You can create a folder assets for all the assets used in the theme, including images, stylesheets, and javascript files.
The following is an example of the files and folders that can be found in typical XCL theme folder structure.

themes
└───theme-name
    │   CHANGELOG.md
    │   manifesto.ini.php
    │   README.md
    │   screenshot.png
    │   theme.html
    │
    ├───component
    ├───css
    ├───images
    ├───js
    ├───language
    └───templates
        ├───d3forum
        ├───legacy
        ├───legacyRender
        ├───message
        ├───pico
        ├───profile
        └───user

License

The Themes are released under a BSD or Creative Commons license.
Some Components and Plugins can be released under licenses that
guarantee a certain specific set of freedoms - GPL, MIT, etc.

LICENSE

Code contributions

If find a bug or it's a feature that you think should be implemented please open an issue first,
join or start a new discussion.

Otherwise, you can follow this process:

  1. Fork the project Fork a Repo
  2. Create a feature branch : git checkout -b my_branch
  3. Push your changes to your new branch : git push origin my_branch
  4. Initiate a pull request About Pull Requests
  5. Your pull request will be reviewed and hopefully merged :)

Have Fun ^_^/