Editor - Frontend Overview

The main bulk of customised Frontend code has been focussed on the fb-editor project. Supporting views for the fb-runner are primarily based on standard GDS templates with minimal, if any, tweaks to support fb-editor requirements.

File structure

The file frontend file structure follows the standard organisation for other Rails based (Webpack setup) files structures. There are too many files to list them all here, but the following outline and example files should give an idea of how things are laid out, and where to start looking.

app/

  assets/
    images/
    stylesheets/

  javascript/
    channels/
    images/
    packs/
      application.js
      govuk.js

    src/
      index.js
      component_dialog.js
      controller_default.js
      ...

    styles/
      application.scss
      _index.scss
      _component_dialog.scss
      ...

  views/
    layouts/
      application.html.erb
      ...

    partials/
      _header.html.erb
      ...

    services/
      index.html.erb

    ...

test/

  setup.js
  component_dialog_test.js
  ...

HTML

HTML files can be found in the app/view folder.

GitHub Files (.html.erb)

Further information and specific topics on Editor HTML

CSS

Stylesheet files can be found in the app/javascript/styles folder.

GitHub Files (.sass)

Further information and specific topics on Editor CSS

JavaScript

JavaScript files can be found in the app/javascript/src folder.

Further information and specific topics on Editor JavaScript

This page was last reviewed on 10 March 2022. It needs to be reviewed again on 10 June 2022 .

This page was set to be reviewed before 10 June 2022. This might mean the content is out of date.