Skip to content

Latest commit

 

History

History
143 lines (99 loc) · 6.76 KB

README.md

File metadata and controls

143 lines (99 loc) · 6.76 KB
Raw

Nuxeo Dev Tools

Chrome Chrome Web Store      Firefox Mozilla Add-on

Build Status

About

This project puts some of the more commonly performed actions in the Nuxeo Platform at the administrator's fingertips in a convenient browser extension.

Features include:

  • Hot Reload on related Studio project
  • Restart server
  • Designer Live Preview
    • See your Designer Web UI customizations without a hot reload -- just save in Designer and refresh your browser.
    • HTML import currently unavailable in Chrome.
  • Rebuild Elasticsearch Index
  • Connect to API Playground
  • Toggle Automation Call Tracing
  • One-click JSON export of document in current active tab
  • Useful Links menu
  • Document Search (search with path, GUID, file name or NXQL query)
    • Click on search results to navigate to document or on export to export JSON
  • Chrome Omnibox
    • Chrome users can access the Nuxeo omnibox by entering keyword nx in the URL box, then TAB.
    • Entering the correct path or GUID of an existing document will open the document JSON in a separate tab.
    • Entering text will perform a full-text search or you can enter an NXQL query.
    • Searches return the first 5 results in a dropdown window from the omnibox.
  • Link to our Customer Feedback Portal from the About page. You can vote for requested features or even suggest your own, anonymously if you wish.

Click on the Nuxeo logo to modify options:

  • Change the Connect URL.
  • Turn off JSON highlighting to use your own JSON formatter plugin (from 10.10+).

Installation

Requirements

  • Nuxeo 8.2 +
  • Install any available hotfixes.

Limitations

  • Multiple Studio projects are not supported.
  • The extension is only active when a Nuxeo instance is in the current active tab.
  • The Hot Reload and Go To Studio buttons are only active when a Studio project is associated with the current Nuxeo server.
  • You must have Administrator access for some features.
  • Dev Mode must be activated to benefit from the Hot Reload feature.
  • CORS config must be activated in your Nuxeo server to connect to your repository on API Playground.
  • The extension does not work in Incognito/Private mode.

Build

$ git clone [email protected]:nuxeo/nuxeo-browser-extension.git
$ cd nuxeo-browser-extension
$ npm install
$ gulp clean build

Developers

Run gulp watch and load the unpacked extension in your preferred browser for your changes to be reloaded immediately.

Firefox

  • Enter about:debugging in the address bar.
  • Click on Load Temporary Add-on....
  • Select nuxeo-browser-extension/dist/firefox/manifest.json.

Chrome

  • Options > More Tools > Extensions
  • Click on the Load Unpacked button.
  • Select nuxeo-browser-extension/dist/chrome.

Debugging

Popup Script
  • Right click on popup page
  • Click Inspect
  • Click on the Console tab
Background Script
  • Options > More Tools > Extensions
  • Scroll down to Nuxeo Dev Tools
  • Ensure Developer Mode is activated (top right corner)
  • Click on background page

Tests

Ensure a Nuxeo server is running and:

  • registered to the bde-test Studio project
  • CORS config is activated
  • dev mode is activated
$ npm install
$ connectUsr=${CONNECT_USERNAME} connectPsw=${CONNECT_PASSWORD} npm run test

...or build and run with Maven:

  • instance.clid is in ./ftest/src/test/resources
$ mvn clean verify -f ftest/pom.xml -DconnectUsr=${CONNECT_USERNAME} -DconnectPsw=${CONNECT_PASSWORD}

Releases

Our release pipeline is bound to any anotated tag created. Distribution artifacts are uploaded and available through Github release screen.

$ git tag -a v1.2.3 -m "Release 1.2.3"

Release pipeline are executed on Jenkins and can be followed here:

Contributing / Reporting issues

Create a ticket with a description of your bug on JIRA.

Please tell us your suggestions for the Dev Tools extension, or any ideas for features that you'd like to see.

License

Apache License, Version 2.0

About Nuxeo

The Nuxeo Platform is an open source customizable and extensible content management platform for building business applications. It provides the foundation for developing document management, digital asset management, case management application and knowledge management. You can easily add features using ready-to-use addons or by extending the platform using its extension point system.

The Nuxeo Platform is developed and supported by Nuxeo, with contributions from the community.

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.