The National Archives: Find Case Law

Introduction

This repository is part of the Find Case Law project at The National Archives. For more information on the project, check the documentation.

Frontend CSS

This repository contains shared SASS and JS for the Find Case Law service. It's used across the Editor UI and the Public UI.

Usage

This repository is not listed on npm, and you will need to add the full git repository path to your package.json:

"dependencies": {
  "@nationalarchives/ds-caselaw-frontend": "git://github.com/nationalarchives/ds-caselaw-frontend#v1.1.0",
  "sass": "^1.58.3"
}

Once installed, import from the correct location in your SCSS, checking that relative paths are correct:

@import "../../node_modules/@nationalarchives/ds-caselaw-frontend/src/main";

Development

Check out this repo, as well as the Editor UI and/or Public UI

In the Editor UI and/or Public UI repository run:

npm link path/to/this/repo

to ensure your development copy loads the local version of this package.

When you're ready, create a PR on this repository. Once it is merged into main, run npm update in the two applications to pull the latest main, and create PRs for the changes to package-lock.json. Once they are merged and deployed, the latest changes will be used.

Releasing

To create a new release of this project:

• On a new branch, run npm version 2.0.x
• Either push the tags up or push the new commit/branch up
• Create a new release in GitHub
• In any project using this package, update it to the latest version