Dotcom/Apps Rendering

This repository contains the rendering logic for articles on theguardian.com. It is a monorepo with 2 projects, apps-rendering and dotcom-rendering.

Developer setup

Install Node.js.

We recommend using fnm. It is great at managing multiple versions of Node.js on one machine.

You may find it useful to add --version-file-strategy recursive to the fnm shell setup. This will set the active Node version to first version it finds in the current directory or any parent directory.

Once Node is installed, make sure you're using the correct package manager by enabling corepack:

corepack enable

Note

If you're using asdf, you'll need to run asdf reshim nodejs after running corepack enable.

Install

Run pnpm install in the root directory of this project to install packages.

Run

You should always cd into the correct subdirectory before running commands (e.g make dev for dotcom-rendering, or pnpm watch for apps-rendering) except for storybook.

apps rendering

Go to apps rendering for more details.

dotcom rendering

Go to dotcom rendering for more details.

Root actions

Most commands are run from within each project but the following are managed from the monorepo root:

Storybook/Chromatic

pnpm storybook - Runs Storybook for all projects pnpm build-storybook - Builds Storybook for all projects

Chromatic now runs at project level. cd into the project dir and run pnpm chromatic -t [CHROMATIC PROJECT TOKEN]

You can find the token in the project Chromatic instance.

To run Chromatic in CI on your pr, add the run_chromatic label once you're ready to check for visual regressions.