buda-base / annotated-etext-react

React component for annotated Etext

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

annotated-etext-react

This is a demo of the principles of the text + annotation that will be used in the BUDA platform. You can find them in the following documents:

Installation

Import into react as usual:

import AnnotatedEtextContainer from 'annotated-etext-react';

Demo

To run the demo:

cd demo
yarn install
yarn start

For developers

Dependencies

After the initial yarn install, you should install flow-typed to get the flow library definitions necessary to fully check your code:

npm -g install flow-typed
flow-typed install

Code management

Transform Flow code to JavaScript before pushing to git: yarn build.

Tests

yarn test

Copyright and License

Copyright (c) 2018 Buddhist Digital Resource Center, distributed under the MIT License.

About

React component for annotated Etext

License:MIT License


Languages

Language:JavaScript 99.1%Language:CSS 0.9%