Development Guide

DocDokuPLM web client

Prerequisites

• DocDokuPLM server (core engine) up and running
• node >= 8.x
• npm
• git
• Apache or Nginx or any proxy capable software (optional)

Npm scripts

Once all is ready you can run the following npm commands :

• npm run dev to launch the grunt server
• npm run clean to clean dist folder
• npm run build to build the app to dist folder
• node_modules/.bin/grunt jshint to validate the code rules

Grunt commands

Run npm install before using grunt

Grunt command is available from node_modules/.bin/grunt

• grunt ou grunt build: build all modules
• grunt build-module:: build a specific module
• grunt serve: serve the application files on port 9001 with livereload
• grunt serve:dist: build the application and serve the dist folder on port 9001
• grunt clean: clean dist folder

The application uses cross-domain requests to a DocDokuPLM server instance, but it can be configured for same protocol, domain and port with a proxy. See the Proxy example configuration page

You can edit app/webapp.properties.json if your configuration is not the default one.

{
    # Define here DocDokuPLM server instance addresss
    "server": {
        "ssl": false,
        "domain": "localhost",
        "port": 8080,
        "contextPath": "/"
    },

    # Define here the context path for the webapp
    "contextPath": "/"
}