NHS Readability App

About

Description of the project

Project Team

• David Herbert, Newcastle University (david.herbert@newcastle.ac.uk)
• Becky Osselton, Newcastle University (rebecca.osselton@newcastle.ac.uk)
• Lorna Dawson, South Tyneside and Sunderland NHS Foundation Trust (lorna.dawson3@nhs.net)
• Nicole Ahmed, South Tyneside and Sunderland NHS Foundation Trust (nicole.ahmed@nhs.net)

RSE Contact

Becky Osselton or David Herbert, RSE Team, Newcastle University

Built With

• React.js
• Uses draft.js library

Getting Started

Clone the repository then:

yarn install

The yarn build has areas that could be improved, but these may be breaking changes.

Running Locally

npm start

Running Tests

How to run tests on your local system.

Roadmap

• [ ] Initial Research
• [ ] Minimum viable product
• [x] Alpha Release
• [ ] Feature-Complete Release

Deployment

The app is automatically deployed to github pages on push to main branch

Main Branch

Not protected currently.

Dev Branch

Should be considered fragile, code should compile and run but features may be prone to errors.

Feature Branches

A branch per feature being worked on.

License