Skip to content
New Nuxeo Web UI
JavaScript HTML Gherkin Java Groovy CSS
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Jenkinsfiles NXP-27317: fix path to mp to be archived Jun 19, 2019
addons NXP-28051: Remove 'GNU/' Nov 15, 2019
charts/preview NXP-27778: remove preview version from Makefile Nov 13, 2019
elements NXP-27981: variable naming refactoring Nov 15, 2019
fonts NXP-25590: deploy and load all font weights locally Oct 24, 2018
ftest NXP-27968: create CSV import ftest Nov 7, 2019
i18n NXP-28051: Remove now obsolete i18n driveDesktopPackages.ubuntu.name Nov 15, 2019
images NXP-27068: mv imap connector web ui resources to addons subdir Mar 27, 2019
packages/nuxeo-web-ui-ftest NXP-27981: rename some css classes and identifiers Nov 15, 2019
plugin NXP-28084: align on NXP-27441 changes Sep 30, 2019
scripts NXP-27912: add test runner script and configurations Sep 17, 2019
server NXP-28140: use nuxeo-web-ui/server base image Oct 18, 2019
themes NXP-27960: cleanup height css variables for nuxeo-results Sep 25, 2019
.babelrc NXP-27912: add test runner script and configurations Sep 17, 2019
.dockerignore NXP-27523: use skaffold to build images Jul 15, 2019
.env.sample NXP-27523: update docs and add docker compose Jul 15, 2019
.eslintignore NXP-27253: activate linting for packages (functional tests framework) Jul 23, 2019
.eslintrc.js NXP-27912: removing test folder inside functional tests Sep 17, 2019
.gitattributes NXP-18431: initial work on the web layout Nov 26, 2015
.gitignore NXP-27523: update docs and add docker compose Jul 15, 2019
.prettierignore NXP-27253: activate linting for packages (functional tests framework) Jul 23, 2019
Dockerfile NXP-28140: use nuxeo-web-ui/server base image Oct 18, 2019
Dockerfile.dev NXP-27912: update dockerfile on dev context Sep 17, 2019
Jenkinsfile Revert "NXP-27778: build preview only with PR label" Nov 4, 2019
README.md NXP-28195: add npm registry config Oct 25, 2019
browserconfig.xml NXP-23082: update web-ui branding colors, logos and favicons Oct 11, 2017
cache-config.json NXP-20794: remove 'app' folder Oct 27, 2016
docker-compose.yml NXP-27985: use pretty domain name for public Docker registry (NXBT-3041) Oct 16, 2019
favicon.ico NXP-23082: update web-ui branding colors, logos and favicons Oct 11, 2017
index.css NXP-25202: define default style values to minimize flashes on Safari Jun 26, 2018
index.html NXP-27751: use form redirection for authentication Jul 17, 2019
index.js NXP-26978: disable comma-dangle on index.js dynamic import May 6, 2019
manifest.json NXP-25700: add cache service worker Aug 31, 2018
package.json NXP-27912: add test runner script and configurations Sep 17, 2019
polymer.json NXP-26978: setup linting Mar 22, 2019
pom.xml NXP-27441: follow changes on packages Sep 25, 2019
prettier.config.js NXP-26978: setup linting Mar 22, 2019
robots.txt NXP-20794: remove 'app' folder Oct 27, 2016
skaffold.yaml NXP-28140: use nuxeo-web-ui/server base image Oct 18, 2019
sw.js NXP-26978: fix prettier Mar 22, 2019
wct.conf.js NXP-26978: fix prettier Mar 22, 2019
webpack.config.js NXP-27523: update docs and add docker compose Jul 15, 2019

README.md

Build Status Codacy Badge

Nuxeo Web UI

About

Nuxeo Web UI is a standard base web application for Nuxeo Platform. It is highly customizable and scalable, developed with Polymer and leveraging nuxeo-elements, our library of custom elements.

Install dependencies

npm config set @nuxeo:registry https://packages.nuxeo.com/repository/npmjs-nuxeo
npm install

Development workflow

Configure

For convenience you should create an .env file to set default environment variables:

cp .env.sample .env

Environment variables

Variable Used by Description Default
NUXEO_PACKAGES Webpack, Docker (Nuxeo) List of packages to enable for Web UI and Nuxeo
NUXEO_URL Webpack URL used to connect to Nuxeo server from Web UI /nuxeo
NUXEO_HOST Webpack Nuxeo host address to proxy calls from the dev server localhost:8080
NUXEO_WEB_UI_VERSION Docker compose Version of Web UI image to build /start
NUXEO_VERSION Docker compose Version of Nuxeo server to launch

Serve / watch

npm run start

This makes the Web UI available on http://0.0.0.0:5000/ to locally test. A nuxeo platform is expected to run on http://0.0.0.0:8080/ with the following cors-config.xml:

<component name="org.nuxeo.corsi.demo">
  <extension target="org.nuxeo.ecm.platform.web.common.requestcontroller.service.RequestControllerService" point="corsConfig">
    <corsConfig name="foobar" supportedMethods="GET,POST,HEAD,OPTIONS,DELETE,PUT" 
exposedHeaders="Accept-Ranges,Content-Range,Content-Encoding,Content-Length,Content-Disposition">
      <pattern>/nuxeo/.*</pattern>
    </corsConfig>
  </extension>
</component>

Run tests

cd ftest
npm run test:dev

This runs the functionnal tests.

Build & Vulcanize

npm run build

Build and optimize the current project, ready for deployment. This includes linting as well as vulcanization, image, script, stylesheet and HTML optimization and minification.

Run with Docker Compose

After building the project with npm run build you can try a Docker compose based deployment with:

docker-compose up --build

This builds the nuxeo-web-ui Docker image and starts the Docker compose cluster.

Web UI will then be available at http://localhost:8080/nuxeo/ui

Production workflow

Marketplace package

mvn clean install

This will build the plugin/web-ui/marketplace/target/nuxeo-web-ui-marketplace-${project.version}.zip Web UI marketplace to be deployed in a nuxeo server.

mvn clean install -Pftest

This also builds the marketplace running the functionnal tests.

License

Apache License, Version 2.0

(C) Copyright Nuxeo Corp. (http://nuxeo.com/)

All images, icons, fonts, and videos contained in this folder are copyrighted by Nuxeo, all rights reserved.

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.

You can’t perform that action at this time.