Nuxeo customer Project Sample

This plugin aims to show how to build and structure a common customer project. It is continuously built from Nuxeo CLI using the bootstrap.sh script.

Structure

It describes a simple project, with several modules:

.
├── docker: Docker Parent Module
│   └── nuxeo-customer-project-sample-docker: Docker Image Module
├── nuxeo-customer-project-sample-core: Core Module
│   ├── nashorn_code_cache
│   │   └── HPgSpJxs_u615DWZjpnU-KW7AyQ_opt
│   └── src
│       ├── main
│       │   ├── java
│       │   └── resources
│       └── test
│           ├── java
│           └── resources
└── nuxeo-customer-project-sample-package: NOS Marketplace Package
    └── src
        └── main
            ├── assemble
            └── resources

Core Module

A Core Module usually contains Java based development. Usually, you will find custom Automation Operation, Listeners, ...

Look at the Nuxeo CLI documentation to discover what you can easily generate. Full documentation about Nuxeo Bundle.

WebApp Module - NXP-29691 Temporarily Removed

A WebApp Module usually contains your Polymer Web Application as a standalone project to let you develop it as any other webapp.

Discover Polymer Guide to help you starting a new project.

Nuxeo Package

A Nuxeo Package usually contains installation instructions and optional constraints towards other packages (dependency, conflict). It is the easiest way to distribute a customer plugin, as it contains in one single ZIP file all the bundles, libraries, configuration properties and templates that are required to make the plugin work.

Full documentation about Nuxeo Package.

Building

Required Configuration - Maven Repository:

nuxeo-studio: NOS Studio Maven repository. Use account username and an application token as password.

<server>
  <id>nuxeo-studio</id>
  <username>username</username>
  <password>{mXjWZLPWowewfa+aZIYrewfds+fsdfq6bRNYVLMn53iqO5cw5xEewqrFUrewr/Szpf}</password>
</server>

Can be automatically set using the nuxeo studio link command from Nuxeo CLI.

mvn clean install

Requirements

See Compiling Nuxeo from sources

Deploying

$NUXEO_HOME/bin/nuxeoctl mp-install nuxeo-customer-project-sample/nuxeo-customer-project-sample-package/target/nuxeo-customer-project-sample-package-*.zip

Resources

Nuxeo CLI

nuxeo-cli npm package

Reporting issues

JIRA bug tracker

Licensing

Apache License, Version 2.0

About Nuxeo

Nuxeo dramatically improves how content-based applications are built, managed and deployed, making customers more agile, innovative and successful. Nuxeo provides a next generation, enterprise ready platform for building traditional and cutting-edge content oriented applications. Combining a powerful application development environment with SaaS-based tools and a modular architecture, the Nuxeo Platform and Products provide clear business value to some of the most recognizable brands including Verizon, Electronic Arts, Sharp, FICO, the U.S. Navy, and Boeing. Nuxeo is headquartered in New York and Paris. More information is available at www.nuxeo.com.