Skip to content

Latest commit

 

History

History
41 lines (21 loc) · 1.59 KB

application-architecture.md

File metadata and controls

41 lines (21 loc) · 1.59 KB

Application architecture

The application generates static HTML pages to preview components, with each component having their own page, these files can be found in app/. To make changes to components, you will have to edit the individual components files within packages/. These are usually the only 2 folders that you will need.


.github/

GitHub specific files, such templates for pull requests and issues.

app/

Nunjuck (HTML) files for the component example pages that you see at http://localhost:3000 when running the application locally and on https://nhsuk.github.io/nhsuk-frontend

dist/ (Automatically generated)

Automatically generated compiled files and build assets for GitHub pages, releases and npm packages. Don't manually edit files in this folder as they will be deleted.

docs/

Markdown files for documentation on GitHub, such as contributing to the project, coding standards and more.

node_modules/ (Automatically generated)

Node package manager modules for third party dependencies. This folder is automatically generated when running npm install. Don't manually edit files in this folder as they will be deleted.

packages/

NHS.UK frontend individual components files, such as all the stylesheet (scss) files, HTML templates (nunjucks), READMEs and assets.

tasks/

Gulp.js tasks to build the dist/ folder from the files in app.

tests/

Test configuration files for our testing frameworks Cypress and BackstopJS. Linting configuration for our linters eslint, htmlhint and sass-lint.


Next: Coding standards and style guide