Getting Started

Dependencies

Before you continue, be sure that you have these tools installed on your machine:

NPM (https://www.npmjs.com)

Install

Get the source from Github:

$ git clone git@github.com:phneutral/viur-css.git

Change into the viur-css root directory:

$ cd <viur-css root>

Install gulp and all dependencies:

$ npm install

You did it!

Let's start.

Build your project

Your Workspace ist /sources/

  • HTML: Write the site in _layout.html and fill html-files in sources/html with cool content. New sites must be added in the _sites.json

  • LESS: Add a less-file in sources/less and create your own elements or customize your project in the app.less and appconf.less

  • JavaScript: Look at the previous point! ... You tried it with Pure CSS? OKAY, add your scripts in sources/less/app.js

  • Icons: Add your own icons in sources/icons

  • Images: Add your images in sources/images

  • Meta: Add your favicon in sources/meta

... And Make it

Change back into the viur-css root directory:

$ cd <viur-css root>

And run the Makefile to compile the appengine-folder:

$ make

You want only compile specific parts? No Problem! Run one of the following commands:

$ make html
$ make gulp
$ make js
$ make css
$ make meta
$ make icons
$ make images
$ make html
$ make iconClass

Well Done!

Look in your appengine folder and open your sites in a browser.