digital-paper-edit-api v1.0.0

Digital Paper Edit - Server API

---> Work in progress <--

See here for overall project architecture info

Setup

git clone git@github.com:bbc/digital-paper-edit-api.git

cd digital-paper-edit-api

Optional step to setup nvm to use node version 10, otherwise just use node version 10

nvm use || nvm install

in root of project

npm install

alternatively for production is also on npm

Usage - development

npm run start:dev

Server API is listening on http://localhost:7080

Usage - production

The project is also publicly available in the npm registry @bbc/digital-paper-edit-api

you can add it to your project

npm install @bbc/digital-paper-edit-api

and eg in an express server you can serve the static build as follows

require('@bbc/digital-paper-edit-api');

See notes in infrastructure repository on Importing JS modules without specifying export for more details on this work.

System Architecture

Express web server API

Development env

• npm > 6.1.0
• node v 10 - lts/dubnium
• see .eslintrc in the various packages for linting rules

Node version is set in node version manager .nvmrc

Build

TBC

Tests

npm test:watch

Deployment

TBC

Contributing

See CONTRIBUTING.md guidelines and CODE_OF_CONDUCT.md guidelines.

Licence

See LICENCE

Legal Disclaimer

Despite using React and DraftJs, the BBC is not promoting any Facebook products or other commercial interest.