application-architecture.md

Application architecture

• bin/

  Binary/executable files (i.e. bash scripts) mainly used in the publishing process.

• dist/ contains auto-generated files

  Standalone builds of govuk-frontend. Provides a way to consume govuk-frontend without using npm.

• docs/

  Documentation files.

• packages/

  • govuk-frontend-review/

    Express.js review app deployed to Heroku with configuration in app.json and Procfile.

    • dist/ contains auto-generated files

      Builds of govuk-frontend-review served by Express.js.

    • src/

      Source files for component previews and examples.

    • tasks/

      Read about npm and Gulp tasks or list workspace specific Gulp tasks using:

      npx --workspace @govuk-frontend/review -- gulp --tasks

  • govuk-frontend/

    Package published on npm. Consume all of govuk-frontend through a single package.

    • dist/ contains auto-generated files

      Builds of govuk-frontend published and exported from the npm package.

    • src/

      Source files. See README.md in the src directory for details.

    • tasks/

      Read about npm and Gulp tasks or list workspace specific Gulp tasks using:

      npx --workspace govuk-frontend -- gulp --tasks

• shared/

  Shared packages used by tests, build tools and the review app.

  • config/

    Configuration files for common paths and port numbers.

  • helpers/

    Jest and development helpers.

  • lib/

    Shared libraries for directory listings, component data, naming conventions.

  • stats/

    File size measurement and module breakdown of built files

  • tasks/

    Read about npm and Gulp tasks for more information about the tasks.