hive-framework
v0.24.1
Published
A website development framework built with Grunt and Sass, with optional support for jQuery UI.
Downloads
72
Maintainers
Readme
Hive framework
A website development framework built with Grunt and Sass, with optional support for jQuery UI. The theme styling is intentionally minimal to make re-skinning easier.
Supported web browsers
- Chrome, Edge, Firefox, Safari and Opera the last two recent stable releases.
- Firefox ESR latest major point release.
Older versions of the above and other browsers may work, but these are the ones we verify.
Requirements
Building this repository requires:
Setup
Installing required tools
The project uses Grunt to run tasks and Sass for CSS pre-processing. First make sure you have base dependencies installed: Node.js and Grunt. You can install Node using the installer and Grunt with npm:
$ npm install -g grunt-cli
Consult the Grunt documentation for more instructions if necessary.
Installing dependencies
After you have the base dependencies taken care of, you can install the project's dependencies. Navigate to the project's directory, and run the dependency manager:
$ cd hive-framework
$ npm install
npm installs Node modules for Grunt (you can also install via Yarn, instead of NPM, if you prefer).
Building
This repository hosts sources and needs to be built before it can be used. After you have installed all dependencies, you will be able to run tasks using Grunt, including building:
$ grunt @task@
Where the @task@
is either build
or watch
.
- The
build
task builds the project. - The
watch
task will launch a task that watches for file changes; the project is then automatically built if a source file is modified.
License
Licensed under MIT license.
Some demo site content is licensed under Creative Commons BY-NC 3.0 (audio: "Moonlight Reprise" from "Irsen's Tale" by Kai Engel) and BY 3.0 (video: "Big Buck Bunny").