Nuxeo Web UI
Nuxeo Web UI is the standard web application for the Nuxeo Platform, built with Polymer 3 and leveraging nuxeo-elements, our library of custom web components.
Prerequisites
- Node.js ≥ 18 (see
enginesinpackage.json) - npm (bundled with Node)
Quick Start
# Install dependencies
npm install
# Create local environment config
cp .env.sample .env
# Start the dev server (http://localhost:5000, proxies API to localhost:8080)
npm startA running Nuxeo Server is expected at http://localhost:8080. To configure CORS, add to nuxeo.conf:
nuxeo.cors.urls=*Environment Variables
| Variable | Used by | Description | Default |
|---|---|---|---|
NUXEO_PACKAGES |
Webpack, Docker | Addon packages whose bundles are loaded at runtime | empty (no addon bundles loaded; resources are still copied) |
NUXEO_URL |
Webpack | URL to connect to Nuxeo server | /nuxeo |
NUXEO_HOST |
Webpack | Nuxeo host address for dev server proxy | 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 |
Commands
| Task | Command |
|---|---|
| Install dependencies | npm install |
| Start dev server | npm start |
| Lint | npm run lint |
| Format | npm run format |
| Unit tests | npm test |
| Functional tests | npm run ftest |
| Production build | npm run build |
| Bundle analysis | npm run build:analyze |
| Maven marketplace | mvn clean install |
| Maven + ftests | mvn clean install -Pftest |
Docker Compose
docker-compose up --buildThis starts an Nginx proxy, Nuxeo Server, and Web UI. The application will be available at http://localhost:8080/.
CI
CI is built on GitHub Actions with workflows for linting, testing, accessibility checks, functional tests, SonarCloud quality scan, and building the marketplace package. PRs tagged preview get ephemeral preview environments with cross-repo support for nuxeo-elements.
Contributing
See CONTRIBUTING.md for setup, coding conventions, testing, and development workflow details.
License
© Hyland Software, Inc. and its affiliates. All rights reserved. All Hyland product names are registered or unregistered trademarks of Hyland Software, Inc. or its affiliates.
All images, icons, fonts, and videos contained in this folder are copyrighted by Hyland Software, all rights reserved.
About Hyland
Hyland is a leading content services provider that enables thousands of organizations to deliver better experiences to the people they serve. Learn more at hyland.com.