readme.md.template

# [$REPO]($URL)

> $DESCRIPTION

[![Build Status][circle-image]][circle-url] [![Dependency Status][devdeps-image]][devdeps-url]

## Local

\`\`\`
npm start
\`\`\`

Build/compile, start a dev server and watches for changes.

# Deploy

1. Write code in a branch.
2. Make a PR. CI will automatically:
    * build and test the branch
    * deploy green builds to the review site
3. Do quick smoke testing of the review build
4. Get a code review. Once you get a thumbs up, merge into main.
5. CI will build, test and deploy a build to Production.


## Uses Starter Kit

This project was scaffolded with [Starter Kit @$REV](https://github.com/ft-interactive/starter-kit/tree/$REV).

## Licence
This software is published by the Financial Times under the [MIT licence](http://opensource.org/licenses/MIT).

Please note the MIT licence includes only the software, and does not cover any FT content made available using the software, which is copyright © The Financial Times Limited, all rights reserved. For more information about re-publishing FT content, please contact our [syndication department](http://syndication.ft.com/).

<!-- badge URLs -->
[circle-url]: https://circleci.com/gh/ft-interactive/$REPO
[circle-image]: https://circleci.com/gh/ft-interactive/$REPO/tree/main.svg?style=shield

[devdeps-url]: https://david-dm.org/ft-interactive/$REPO#info=devDependencies
[devdeps-image]: https://img.shields.io/david/dev/ft-interactive/$REPO.svg?style=flat-square