unibo / application_theme

This is the official Unibo Application Theme based on Foundation for Sites. Unibo Application Theme is suited for the creation and development of application website in University of Bologna network.

Home Page:https://unibo.github.io/application_theme/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

UNIBO APPLICATION THEME

This is the official Unibo Application Theme based on Foundation for Sites. Unibo Application Theme is suited for the creation and development of application website in University of Bologna network.

Unibo Application Theme inherits all the features, components, mixins, grid systems, and more already present in Foundation 6. It has a Gulp-powered build system with these features:

  • Handlebars HTML templates with Panini
  • Sass compilation and prefixing
  • JavaScript module bundling with webpack
  • Built-in BrowserSync server
  • For production builds:
    • CSS compression
    • JavaScript module bundling with webpack
    • Image compression

Installation

To use this template, your computer needs:

How clone and create a new site from this package

To manually set up the template, first download it with Git:

git clone https://github.com/unibo/application_theme.git projectname

Then open the folder in your command line, and install the needed dependencies:

cd projectname
yarn

Finally, run yarn start to run Gulp.

Your finished site will be created in a folder called dist, viewable at this URL:

http://localhost:8000/

If you need to create compressed, production-ready assets, run.

yarn run build

Repository structure

Here a brief description for repository structure.

src
├─ assets         All static files, scss and javascript files.
   ├─ img         * Images used in Application Unibo Theme.
   ├─ js          * All javascript that are not incorporated via webpack and app.js for configuration.
   ├─ scss        * All scss divided into folders by functionality
   └─ webfonts    * Used Fonts in Application Unibo Theme.
├─ data       
└─ layout         List of used template in theme.
   ├─ default     * Default Template for pages created in folder "pages".
   ├─ styleguide  * Template used for styleguide pages.
└─ pages          List of all pages.
   ├─ index       * Main page of the theme, to be updated manually, to view the content list.
   ├─ styleguide  * All styleguide pages.
   ├─ layout      * All example pages.
└─ partials       All html snippets used in pages.

Bug reports and requests for help

Is something get wrong or it's not what you expected? Please open an issue in this repository on github. Thank you for contributing!

License software of third part component

The components distributed with Unibo Applicatione Theme that have their own license other than CC0 are listed below.

Main dependencies for the build and development

  • NodeJS (Version 10 or greater recommended, tested with 10)
  • SASS node-sass, © Andrew Nesbitt, license MIT

How to use

Using this styleguide is very simple and immediate.

Download the starter kit, add <link rel="stylesheet" href="css/app.css"> inside tag <head> and <script src="js/app.js"> at the bottom of page (before end of tag <body>).

Choose a template from our styleguide and start code!

Example can be found in our demo site (italian language).

Copyright and terms of use

The license of Unibo Applicatione Theme is BSD 3-Clause and is visible in LICENSE file.

If you use Unibo Applicatione Theme for your projects, the link to this repository must be reported in the software interface exposed to the public.

Logos and Brand

About

This is the official Unibo Application Theme based on Foundation for Sites. Unibo Application Theme is suited for the creation and development of application website in University of Bologna network.

https://unibo.github.io/application_theme/

License:BSD 3-Clause "New" or "Revised" License


Languages

Language:HTML 71.6%Language:SCSS 25.3%Language:JavaScript 2.2%Language:CSS 0.8%