ERGO FRONT

Develpoment

Base assets for each tag are available as bundled zip files at https://ergo-front.cube.lv/.

There are two ways of using these assets during SYSTEM development.

Using prebuilt public assets

Public asset bundle contains fully processed assets. All files are compiled, minified and versioned.

1. Download latest public asset bundle from https://ergo-front.cube.lv/packages/latest/public
2. Extract the zip file into the local development environment
3. Use the new rev-manifest.json to locally resolve the latest base asset names

Using asset sources

Asset source bundle contains all assets in unprocessed source form as they have been created on FRONT.

Using the source versions instead of the prebuilt public versions has some benefits:

• When creating additional custom scripts, it is possible to browse the code of base scripts directly, since the files are not yet combined and minified. This can help with understanding how the code works. It is also possible to make temporary edits in these files to help with debugging.
• When creating additional custom stylesheets, it is possible to reuse the original SASS environment (color variables, layout mixins etc) by importing environment.scss from base stylesheets folder

To use the source files in development, they need to be compiled locally.

Prerequisites

1. Install Node (20+)
2. npm install gulp-cli -g (Install gulp CLI globally)
3. Add public/assets and node_modules to the SYSTEM site’s .gitignore file

Downloading asset sources

1. Download latest asset sources from FRONT https://ergo-front.cube.lv/packages/latest/sources
2. Extract the zip file into the local development environment. This should create a folder named gulp. gulp/base folder needs to be deleted beforehand to ensure that no outdated source files are left over.
3. Delete the downloaded zip file

Asset compilation

1. cd gulp (Switch to folder where the asset sources have been extracted)
2. npm install (Install all required packages for ERGO asset system)
3. gulp (Compile all assets and launch a watch process on the asset source folders)

Assets are compiled into ../public/assets/ folder relative to the gulp folder and are automatically recompiled anytime any of the source files are changed as long as the gulp process is left running.

This generates unversioned assets which should be used in the page directly without a rev-manifest.json file.

If needed, a full build can be performed by stopping the gulp task and running gulp build, rev-manifest.json file.

In case prebuilt versioned assets have been used earlier or gulp build has been performed locally, run gulp clean before running gulp to remove any previously compiled versioned assets. This deletes all compiled assets and manifest file from ../public/assets/.

Acquiring static page HTML code from FRONT

Download the zip file containing static HTML files of all pages for the latest tag from FRONT staging.

Compare differences between files in the previous downloaded package and the new one. A broad description of what to look for and what has changed in HTML between tags is written in the changelog in tag comments (shown on FRONT staging with each tag).