Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nuxeo/nuxeo-web-ui
New Nuxeo Web UI
https://github.com/nuxeo/nuxeo-web-ui
nuxeo polymer web-components
Last synced: 3 days ago
JSON representation
New Nuxeo Web UI
- Host: GitHub
- URL: https://github.com/nuxeo/nuxeo-web-ui
- Owner: nuxeo
- Created: 2015-11-26T15:33:53.000Z (almost 9 years ago)
- Default Branch: maintenance-3.1.x
- Last Pushed: 2024-10-30T05:23:43.000Z (21 days ago)
- Last Synced: 2024-10-30T06:26:56.875Z (21 days ago)
- Topics: nuxeo, polymer, web-components
- Language: JavaScript
- Homepage:
- Size: 133 MB
- Stars: 59
- Watchers: 49
- Forks: 61
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
[](https://jenkins.webui.dev.nuxeo.com/job/nuxeo/job/nuxeo-web-ui/job/master/)
[](https://www.codacy.com/app/Nuxeo/nuxeo-web-ui)
## 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](https://polymer-library.polymer-project.org/) and leveraging [nuxeo-elements](https://github.com/nuxeo/nuxeo-elements), our library of custom elements.
### Install dependencies
```sh
npm install
```
**Note: This version of Nuxeo Web UI requires node version >=14.0.0 <15.0.0.**
### Development workflow
#### Configure
For convenience you should create an `.env` file to set default environment variables:
```sh
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
```sh
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/`. To configure CORS, we need to add the following line to `nuxeo.conf` file in our Nuxeo Server:
```
nuxeo.cors.urls=*
```
#### Run tests
The following commands can be run in order to run tests against Web UI.
##### Unit Tests
```sh
npm run test
```
##### Functional Tests
```sh
npm run ftest
```
#### Build & Vulcanize
```sh
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:
```sh
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
```sh
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.
```sh
mvn clean install -Pftest
```
This also builds the marketplace running the functionnal tests.
### CI using Github Actions
At the moment, CI for Nuxeo Web UI is built on top of [Github Actions](https://github.com/features/actions). We currently provide worflow definitions for building and testing Nuxeo Web UI, to setup preview environments for pull requests, and to promote new releases.
Although there are no cross-repo support for building and testing Nuxeo Web UI with [nuxeo-elements](https://github.com/nuxeo/nuxeo-elements/tree/maintenance-3.1.x), preview environments are setup with cross-repo support. To this extent, in pull requests annotated with the tag `preview`, the workflow will lookup for a corresponding branch with the same name in `nuxeo-elements` repo, and use it in the preview instance.
## License
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html)
©2023 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 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.