1 | # React Transcript Editor
|
2 |
|
3 |
|
4 |
|
5 | A React component to make transcribing audio and video easier and faster.
|
6 |
|
7 | [![install size](https://packagephobia.now.sh/badge?p=@bbc/react-transcript-editor)](https://packagephobia.now.sh/result?p=@bbc/react-transcript-editor)
|
8 |
|
9 | The project uses [this github project board to organise and the co-ordinate development](https://github.com/bbc/react-transcript-editor/projects/1).
|
10 |
|
11 | _--> Work in progress <--_
|
12 |
|
13 |
|
14 |
|
15 | ## Development env
|
16 |
|
17 |
|
18 |
|
19 | - npm > `6.1.0`
|
20 | - [Node 10 - dubnium](https://scotch.io/tutorials/whats-new-in-node-10-dubnium)
|
21 |
|
22 | Node version is set in node version manager [`.nvmrc`](https://github.com/creationix/nvm#nvmrc)
|
23 |
|
24 |
|
25 |
|
26 |
|
27 |
|
28 | ## Setup
|
29 |
|
30 |
|
31 |
|
32 |
|
33 | Fork this repository + git clone + cd into folder
|
34 |
|
35 | ## Usage - development
|
36 |
|
37 |
|
38 |
|
39 | > To start the development server (with entry point `src/index.js`), run
|
40 |
|
41 | ```
|
42 | npm start
|
43 | ```
|
44 |
|
45 | Visit [http://localhost:3000](http://localhost:3000)
|
46 |
|
47 | ## Usage - production
|
48 |
|
49 |
|
50 |
|
51 |
|
52 |
|
53 |
|
54 | Available on [npm - `@bbc/react-transcript-editor`](https://www.npmjs.com/package/@bbc/react-transcript-editor)
|
55 |
|
56 | ```
|
57 | npm install @bbc/react-transcript-editor
|
58 | ```
|
59 |
|
60 | ```js
|
61 | import { TranscriptEditor } from '@bbc/react-transcript-editor';
|
62 |
|
63 | <TranscriptEditor
|
64 | transcriptData=// Transcript json
|
65 | mediaUrl=// string url to media file - audio or video
|
66 | isEditable={true}// set to true if you want to be able to edit the text
|
67 | sttJsonType={ 'bbckaldi' } // the type of STT Json transcript supported.
|
68 | handleAnalyticsEvents={ this.handleAnalyticsEvents } // optional - if you want to collect analytics events.
|
69 | fileName=// optional - used for saving and retrieving local storage blob files
|
70 | title=// optional - defaults to ''
|
71 | ref={ this.transcriptEditorRef } // optional - if you want to have access to internal functions such as retrieving content from the editor. eg to save to a server/db.
|
72 | />
|
73 | ```
|
74 | See [`./src/index.js` demo](./src/index.js) as a more detailed example usage of the component.
|
75 |
|
76 | _Note: `fileName` it is optional but it's needed if working with user uploaded local media in the browser, to be able to save and retrieve from local storage. For instance if you are passing a blob url to `mediaUrl` using `createObjectURL` this url is randomly re-generated on every page refresh so you wouldn't be able to restore a session, as `mediaUrl` is used as the local storage key. See demo app for more detail example of this[`./src/index.js`](./src/index.js)_
|
77 |
|
78 | ### Typescript projects
|
79 |
|
80 | If using in a parent project where [typescript](https://www.typescriptlang.org/) is being used you might need to add `//@ts-ignore` before the import statment like this
|
81 |
|
82 | ```js
|
83 | //@ts-ignore
|
84 | import { TranscriptEditor } from "@bbc/react-transcript-editor";
|
85 | ```
|
86 |
|
87 | ## System Architecture
|
88 |
|
89 |
|
90 |
|
91 | uses [`create-component-lib`](https://www.npmjs.com/package/create-component-lib) as explaied in this [blog post](https://hackernoon.com/creating-a-library-of-react-components-using-create-react-app-without-ejecting-d182df690c6b) to setup the environment to develop this React.
|
92 |
|
93 | This uses [Create React App 2.0](https://reactjs.org/blog/2018/10/01/create-react-app-v2.html) so we are using [CSS Modules](https://github.com/css-modules/css-modules) to contain the scope of the css for this component.
|
94 |
|
95 | Uses CSS grid-layout https://medium.com/samsung-internet-dev/common-responsive-layouts-with-css-grid-and-some-without-245a862f48df -->
|
96 |
|
97 | > Place everything you want to publish to npm inside `src/lib`.
|
98 |
|
99 | > Outside `src/lib` (but inside src/), you can create example web pages to test or demonstrate the usage of your components.
|
100 |
|
101 | ## Documentation
|
102 |
|
103 | There's a [docs](./docs) folder in this repository.
|
104 |
|
105 | [docs/notes](./docs/notes) contains dev notes on various aspects of the project.
|
106 |
|
107 | [docs/adr](./docs/adr) contains [Architecture Decision Record](https://github.com/joelparkerhenderson/architecture_decision_record).
|
108 |
|
109 | > An architectural decision record (ADR) is a document that captures an important architectural decision made along with its context and consequences.
|
110 |
|
111 | We are using [this template for ADR](https://gist.github.com/iaincollins/92923cc2c309c2751aea6f1b34b31d95)
|
112 |
|
113 | [There also QA testing docs](./docs/qa/README.md) to manual test the component before a major release, (QA testing does not require any technical knowledge).
|
114 |
|
115 | ## Build
|
116 |
|
117 |
|
118 |
|
119 | > To transpile `src/lib` and create a build in the dist folder, run:
|
120 |
|
121 | ```
|
122 | npm run build:component
|
123 | ```
|
124 |
|
125 | ## Demo
|
126 |
|
127 | Demo can be viewed at [https://bbc.github.io/react-transcript-editor](https://bbc.github.io/react-transcript-editor)
|
128 |
|
129 |
|
130 | -->
|
131 |
|
132 | ## Build - demo
|
133 |
|
134 | This github repository uses [github pages](https://pages.github.com/) to host a demo of the component, in [docs/demo](./docs/demo)
|
135 |
|
136 | ```
|
137 | npm run deploy:ghpages
|
138 | ```
|
139 |
|
140 | add to git, and push to origin master to update
|
141 |
|
142 |
|
143 |
|
144 | Alternatively If you simply want to build the demo locally in the `build` folder then just
|
145 |
|
146 | ```
|
147 | npm run build:example
|
148 | ```
|
149 |
|
150 | ## Tests
|
151 |
|
152 |
|
153 |
|
154 | Test coverage using [`jest`](https://jestjs.io/), to run tests
|
155 |
|
156 | ```
|
157 | npm run test
|
158 | ```
|
159 |
|
160 | ## Deployment
|
161 |
|
162 |
|
163 |
|
164 | To push to [npm - `@bbc/react-transcript-editor`](https://www.npmjs.com/package/@bbc/react-transcript-editor)
|
165 |
|
166 | ```
|
167 | npm publish:public
|
168 | ```
|
169 |
|
170 | This runs `npm run build:component` and `npm publish --access public` under the hood
|
171 |
|
172 | > Note that only `README.md` and the `dist` folders are published to npm.
|
173 |
|
174 | ## Contributing
|
175 |
|
176 | See [CONTRIBUTING.md](./CONTRIBUTING.md) guidelines and [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md) guidelines.
|
177 |
|
178 | ## Licence
|
179 |
|
180 |
|
181 |
|
182 | ## Legal Disclaimer
|
183 |
|
184 | Despite using React and DraftJs, the BBC is not promoting any Facebook products or other commercial interest.
|