Project Structure

The project generated by Jetray looks like the layout provided below. Note that this same general structure is used for both React and Angular portlet projects, although some files appear only in one environment or the other, and other files (e.g., gupfile.js, webpack configs, etc.) will be different between the two frameworks.

  • _libUtility scripts used by gulpfile for JAR construction and DXP deployment
  • _liferayLiferay configuration files, JSPs, etc.
  • jetdbJSON Services module and example data file
  • [framework]_runtimeAngular or React runtime and portlet loader script
  • srcSource files for Angular or React sample application
  • .yo-rc.jsonSaved settings from yeoman generator execution
  • gulp-config.jsConfiguration file that allows gulp to be used in both npm and gradle environments
  • gulpfile.jsMaster build and deploy script.
  • package.json
  • webpack.config.jsWebpack configuration used to bundle application in development mode
  • webpack.config.prod.js | webpack.config.aot.jsWebpack configuration used to bundle application in production mode
  • tsconfig.jsonTypescript compile options for development (JIT) mode (Angular only)
  • tsconfig_aot.jsonTypescript compile options for production (AoT) mode (Angular only)
  • typings.jsonTypescript d.ts files for system elements (Angular only)

We just included layouts files for your reading pleasure. You should choose one of those and start customizing components such as navbar, banner, sidebar and footer to make a starter file for your documentation. You can access to all of the available files in "Documentation" or "src" folder.