Skip to content
This repository has been archived by the owner on Jan 22, 2019. It is now read-only.

Prototype of API for content quality metrics based on retext

License

Notifications You must be signed in to change notification settings

alphagov/govuk-content-quality-metrics

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

govuk-content-quality-metrics

Prototype of API for content quality metrics based on retext

Usage

Make a POST request with "Content-Type" : "application/json" to.

https://govuk-content-quality-metrics.cloudapps.digital/metrics

The posted body should have the format:

{"content": "the text content goes here. and another sentence"}

Testing

Specs are written using mocha/chai/chaiHttp.

you can install mocha with

npm install --global mocha

Then you can use:

mocha ./**/*.spec.js -w

to watch the tests and run them on any changes.

Deploying the app

This application is hosted using GOV.UK Platform as a Service (PAAS).

In order to deploy new versions of this app you will need a PAAS account, which you can request by emailing gov-uk-paas-support@digital.cabinet-office.gov.uk, and to have installed the Cloud Foundry CLI.

When you have made changes and wish to deploy them simply run cf push govuk-content-quality-metrics from the top level of the directory which contains all the code and configuration files.

For more information please see the PAAS docs

TODO

  • check if this fits in with the govuk guidelines on node apps.

About

Prototype of API for content quality metrics based on retext

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published