Skip to content

Commit

Permalink
Merge pull request #4021 from alphagov/v4-stats-docs
Browse files Browse the repository at this point in the history
Add README for stats package
  • Loading branch information
colinrotherham authored Jul 28, 2023
2 parents 0876176 + 70aede2 commit 8864297
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions shared/stats/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# GOV.UK Frontend stats

This package is used to generate Rollup visualizer stats for built GOV.UK Frontend modules.

```shell
npm run build:stats --workspace govuk-frontend
```

Stats are shown in the review app [deployed to Heroku](https://govuk-frontend-review.herokuapp.com) or when run locally using `npm start`.

## Stats for previous version

GOV.UK Frontend is resolved from [./packages/govuk-frontend](../../packages/govuk-frontend/) unless a previous version is installed locally:

```shell
npm install [email protected] --save --workspace govuk-frontend-stats
```

0 comments on commit 8864297

Please sign in to comment.