@guardian/flexible-frontend
v0.1.2
Published
This project serves as the foundation for migrating Composer from AngularJS to React. The repository includes a Staging App and a reusable Component Library, both implemented in React with TypeScript. Additionally, components from the new library are inte
Downloads
4
Keywords
Readme
Flexible Frontend
This project serves as the foundation for migrating Composer from AngularJS to React. The repository includes a Staging App and a reusable Component Library, both implemented in React with TypeScript. Additionally, components from the new library are integrated into the legacy AngularJS app using the React2Angular library.
Staging App
Overview
The Staging App provides a controlled environment for testing and developing & integrating components from the library to replace existing logic & interface elements in Composer. It is designed to be the starting point for the migration process, ensuring a smooth transition from AngularJS to React.
Getting Started
Install dependencies
cd flexible-frontend
nvm use
npm i
Complete the nginx setup by running ./setup.sh
from the flexible-content directory root
Run the app
./scripts/dev-start.sh
the staging app should be available at https://composer.local.dev-gutools.co.uk
Testing
The Staging App is unit-tested using React Testing Library. Run the tests with:
npm run test
Accessibility Testing
Accessibility testing is performed using the axe-playwright
library. Run the tests with:
npm run axe-tests
Visual Testing
Changes to the component library should be tested visually using Chromatic. Add the run_cromatic
label to a pull request to trigger a visual test run. Note that the run_chromatic
action is not triggered on github if the branch has merge conflicts with main.
Visit the Chromatic dashboard for visual test results.
Component Library
Overview
The Component Library is a collection of reusable React components developed with TypeScript. These components are designed to be shared between the Staging App and the existing AngularJS application.
Viewing existing components
cd flexible-frontend
nvm use
npm i
npm run storybook
The components with be available at http://localhost:6006
React2Angular Integration
Components from the new library are integrated into the legacy AngularJS app using the React2Angular library. This allows seamless usage of React components within the AngularJS application and for new feature development in the legacy app to be built in the component library.