gentics-ui-core

Gentics UI Core

This is the common core framework for the Gentics CMS and Mesh UI, and other Angular applications.

Using ui-core in a project

1. Install via npm:

npm install gentics-ui-core --save

1. Import the module and add it to your apps root module:

// app.module.ts
import { FormsModule, ReactiveFormsModule } from '@angular/forms';
import { GenticsUICoreModule } from 'gentics-ui-core';

@NgModule({
    // ...
    imports: [
        FormsModule,
        GenticsUICoreModule.forRoot(),
        ReactiveFormsModule
    ]
}
export class AppModule { }

Documentation

Full documentation and examples are available at https://gentics.github.io/gentics-ui-core/

Building the docs app

Although the UI Core is intended to be consumed in a raw (uncompiled) state, there is a demo app included under src/demo which will serve as a "living style guide" as well as a way to manually test each of the core components.

1. npm install
2. gulp docs:build
3. Serve the contents of the docs/ folder

Releasing

1. npm shrinkwrap
2. git commit -am 'vX.Y.Z'
3. git tag vX.Y.Z
4. git reset --hard HEAD^
5. git push origin vX.Y.Z master

Publish to npm

1. gulp dist:build
2. npm publish

Maintaining documentation on GitHub pages

Documentation is built as a static Angular app into "docs" and maintained on the branch "gh-pages". The easiest way to manage the branch is to check it out in the "docs" subfolder:

# check out ui-core twice, master in ./ and gh-pages in ./docs
git clone -o github -b gh-pages [e-mail]:gentics/gentics-ui-core ./docs
# build the docs
gulp docs:build
# commit and push gh-pages
cd docs
git add .
git commit -m "Update docs to vX.Y.Z"
git push github