1.0.0 • Published 5 years ago

@bbc/digital-paper-edit-api v1.0.0

Weekly downloads
-
License
MIT
Repository
-
Last release
5 years ago

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

Usage

npm start

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

System Architecture

Express web server API

Development env

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.