Skip to content

Client Folder Structure

DeclanBuckley edited this page Dec 8, 2023 · 24 revisions

Home / Developer / Client Tier / Folder Structure.

This is the folder structure at the root level of the Client Code:

root/

  • /config
  • /css
  • /entity
  • /image
  • /internationalisation
  • /js
  • /template

/config

This folder contains the Client Code configuration files in JSON format. Please refer to the documentation about the Client Code Configuration.

/css

This folder contains the CSS styling definitions at the global level. Stylesheets that are page specific are rather defined into each Entity.

/entity

This folder contains the Entities available in the application.

N.B. Entities are self-contained modules (including specific JS and CSS resources) that can be moved anywhere within the application.

/image

This folder contains the images used at the global level. The default images are based on a white-label look & feel that can be simply replaced.

/internationalisation

This folder contains the internationalisation files in JSON format to allow the multi-lingual interface. Each subfolder is named after the language ISO code https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes

N.B. en (English) is the master language. Any missing language definitions will automatically default to the English one.

/js

This folder contains the Javascript files running at the global level. Javascript files that are page specific are rather defined into each Entity.

  • /template This folder contains the templates available at the global level (i.e. Site Header/Footer/Navigation/Spinner etc...) Templates that are page specific are rather defined into each Entity.
Clone this wiki locally