Commit 61430f95 authored by Ate Douma's avatar Ate Douma

TRIVIAL cleanup master

parent 57366725

Too many changes to show.

To preserve performance only 1000 of 1000+ files are displayed.

This diff is collapsed.
Hippo Essentials
Copyright 2013-2018 Hippo B.V., Amsterdam, The Netherlands (
This product includes software developed by:
Hippo B.V., Amsterdam, The Netherlands (;
The Apache Software Foundation (
NOTICE: Only our own original work is licensed under the terms of the
Apache License Version 2.0. The licenses of some libraries might impose
different redistribution or general licensing terms than those stated in the
Apache License. Users and redistributors are hereby requested to verify these
conditions and agree upon them.
# Hippo Essentials
Hippo Essentials is for developers who want to setup a new [Hippo CMS]( project. It enables
them to kickstart their project in a matter of minutes, to benefit from our best practices and to easily add Enterprise
or community plugins from the Hippo Marketplace.
# This is not the branch you're looking for...
Please use the Hippo Essentials feedback form to inform us if you encounter any bugs/glitches or if you have any
suggestions for improvements.
BloomReach only provides the git trees for the release tags of Hippo CMS, as explained on
# Getting Started
To checkout the code for a specific release tag, after cloning this repository, use the following:
## Code checkout
## to show the available tags
To get started with the Hippo Essentials, checkout the code. You have two options to check out
the project. The example commands below use the potentially unstable trunk snapshot. Consider
using a tag instead.
git tag
### Read-only
git clone
## to checkout a specific tag
### Read-write (you'll need Hippo GIT account for this)
git clone
git checkout <tag name>
### Build the essentials components:
cd hippo-essentials
mvn clean install
## to modify a project
If you want to make modifications to a project, for example to create a patch, create a new fork branch from the specific tag like this:
### Validate license headers:
mvn clean && mvn validate -Ppedantic
### Create and install archetype locally:
git clone
cd hippo-project-archetype
mvn clean install
### Generate a new Hippo project from the archetype (use appropriate archetype version):
mvn archetype:generate -D "archetypeGroupId=org.onehippo.cms7" -D "archetypeArtifactId=hippo-project-archetype" -D "archetypeVersion=[archetype version]"
##Running locally
This project uses the Maven Cargo plugin to run the CMS, Website and Essentials dashboard locally in Tomcat.
From the project root folder, execute:
mvn clean verify
mvn -P -Drepo.path=storage
The following URLs are available from this project:
* CMS at http://localhost:8080/cms
* Website at http://localhost:8080/site
* Essentials dashboard at http://localhost:8080/essentials
Logs are located in `target/tomcat8x/logs`
##Using JRebel
Set the environment variable `REBEL_HOME` to the directory containing jrebel.jar.
Build with:
mvn clean install -Djrebel
Start with:
mvn -P -Djrebel
##Best Practice for development
Use the option `-Drepo.path=/some/path/to/repository` during start up. This will avoid
your repository to be cleared when you do a mvn clean.
For example start your project with:
mvn -P -Drepo.path=/home/usr/tmp/repo
or with jrebel:
mvn -P -Drepo.path=/home/usr/tmp/repo -Djrebel
##Hot deploy
To hot deploy, redeploy or undeploy the CMS or site:
cd cms (or site)
mvn cargo:redeploy (or cargo:undeploy, or cargo:deploy)
##Automatic Export
Essentials depends on the automatic export feature being enabled, which is the archetype-generated Hippo
project's default setting. You can change the setting temporarily in the upper right corner in the CMS,
or permanently in your project's file
##Copyright and license
Copyright 2013-2016 Hippo B.V.
Distributed under the [Apache 2.0 license](
git checkout -b forked-<tag name> <tag name>
For the latter, also see the **Build from Source** documentation at
\ No newline at end of file
This diff is collapsed.
* Copyright 2015-2018 Hippo B.V. (
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* See the License for the specific language governing permissions and
* limitations under the License.
module.exports = function gruntFunctions(grunt) {
'use strict';
// display execution time of each task
// load all grunt tasks automatically
// project configuration
build: require('./build.config.js'),
watch: {
all: {
files: ['src/main/webapp/**/*'],
tasks: ['build']
// clean target (distribution) folder
clean: {
target: {
src: '<%= build.dashboardtarget %>',
jshint: {
files: 'src/main/webapp/js/*.js',
// copy files to target folder
copy: {
components: {
files: [
expand: true,
cwd: '<%= build.npmDir %>',
dest: '<%= build.dashboardtarget %>',
src: [