View File | Revision Log | Show Annotations | Download File | View Changeset
/hippo/hippo-cms7/frontend/theme/branches/hippo-theme-restyling/README.md
Revision: 51588
Committed: Tue Feb 17 15:18:15 2015 UTC (4 years, 9 months ago) by mdenburger
File size: 1758 byte(s)
Log Message:
HIPPOTHEME-40: merge r51305 through r51587 from trunk

File Contents

# Content
1 Hippo Theme
2 ===========
3
4 [![Build Status](https://travis-ci.org/onehippo/hippo-theme.png?branch=master)](https://travis-ci.org/onehippo/hippo-theme)
5
6 The Hippo theme is a centralised library containing reusable components for Hippo-related projects.
7 You can use it to create clickable mockups or end-projects that need to be in line with the Hippo styling.
8
9 ## Development environment setup
10 #### Prerequisites
11
12 * [NodeJS](https://nodejs.org/) (NodeJS)
13 * [Node Package Manager](https://npmjs.org/) (NPM)
14 * [Git](http://git-scm.com/)
15
16 #### Dependencies
17
18 * [Grunt](http://gruntjs.com/) (task automation)
19 * [Bower](http://bower.io/) (package management)
20
21 #### Installation
22 Run the commands below in the project root directory.
23 #####1. Install Grunt and Bower
24
25 $ sudo npm install -g grunt-cli bower
26
27 #####2. Install project dependencies
28
29 $ npm install
30 $ bower install
31
32 ## Useful commands
33
34 ####Generate build
35 The build version is located in the `dist` directory.
36
37 $ grunt build:dist
38
39 ####Generate demo website
40 The build version is located in the `demo` directory. After building you can publish it to the [Hippo Theme Demo](https://github.com/onehippo/hippo-theme-demo).
41
42 $ grunt build:demo
43
44 ####Run tests
45 The tests need to pass in order to build the demo.
46
47 $ grunt test
48
49 ####Setup server
50 The browser will show the demo website which shows all available compontents for the theme.
51
52 $ grunt server:demo
53
54 ####Publish to the [Hippo Theme demo repository](https://github.com/onehippo/hippo-theme-demo)
55 Create an [online demo](http://onehippo.github.io/hippo-theme-demo/) of the Hippo Theme.
56
57 $ grunt publish
58
59 ## Deployment to Nexus
60 #### Prerequisites
61
62 * [Maven](http://maven.apache.org/)
63
64 #### Deployment command
65
66 $ mvn deploy
67