Skip to content
This repository has been archived by the owner on Mar 30, 2022. It is now read-only.

Latest commit

 

History

History
52 lines (33 loc) · 2.01 KB

README.md

File metadata and controls

52 lines (33 loc) · 2.01 KB
Raw

⚠️ Under new stewardship

eLife have handed over stewardship of Libero Edtior to The Coko Foundation. You can now find the updated code repository at https://gitlab.coko.foundation/libero/editor-client and continue the conversation on Coko's Mattermost chat server: https://mattermost.coko.foundation/

For more information on why we're doing this read our latest update on our new technology direction: https://elifesciences.org/inside-elife/daf1b699/elife-latest-announcing-a-new-technology-direction

Editor Client

A web app for editing article in JATS format. Built with react/redux and prosemirror.

Develop

Run the editor locally in dev mode in 3 simple steps

  1. git clone [email protected]:libero/editor-client.git && cd editor-client
  2. npm install
  3. npm start

A new browser window with open automatically. If it doesn't simply navigate to http://localhost:3000 in your favourite browser.

The page will reload automatically if you make edits.
You will also see any lint errors in the console.

Running all services in development mode with client reloading

This requires the editor-article-store repo being cloned to the same directory as the editor-client repo.

.
├── editor-article-store
├── editor-client
  1. make start_all
  2. Go to http://localhost:3000 or http://localhost:9000

Test

npm test launches the test runner in the interactive watch mode.
On any changes the tests will re-run automatically.

Build

npm run build builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.

Documentation

Architectural documentation can be found here, it is advised to read through this document before attempting to extend editor-client as it details many of the abstractions and data model used internally.