Home

Awesome

Digital Paper Edit - Server API

---> Work in progress <--

<!-- _One liner + link to confluence page_ _Screenshot of UI - optional_ -->

See here for overall project architecture info

Setup

<!-- _stack - optional_ _How to build and run the code/app_ --> 
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

<!-- _High level overview of system architecture_ -->

Express web server API

Development env

<!-- _How to run the development environment_ _Coding style convention ref optional, eg which linter to use_ _Linting, github pre-push hook - optional_ -->

Node version is set in node version manager .nvmrc

Build

<!-- _How to run build_ -->

TBC

Tests

<!-- _How to carry out tests_ --> 
npm test:watch

Deployment

<!-- _How to deploy the code/app into test/staging/production_ -->

TBC

Contributing

See CONTRIBUTING.md guidelines and CODE_OF_CONDUCT.md guidelines.

Licence

<!-- mention MIT Licence -->

See LICENCE

Legal Disclaimer

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