4.0.0 • Published 22 days ago
@financial-times/n-map-content-to-topper v4.0.0
n-map-content-to-topper
A library for mapping content to a topper on FT.com and the App.
Table of Contents
Requirements
- Node 12.x
- Vault
Installation
git clone https://github.com/Financial-Times/n-map-content-to-topper.git
cd n-map-content-to-topper
make .env
make install
Development
Testing
In order to run the tests locally you'll need to run:
make test
Install from NPM
npm install @financial-times/n-map-content-to-topper
Usage
const { mapContentToTopper } = require('@financial-times/n-map-content-to-topper');
const topper = mapContentToTopper(content, flags);
Release Process
The project is released automatically to npm via Github Releases. Create a release, and name the tag with the Semantic Versioning version you want. The CircleCI build for the tag will release that version to npm.