Skip to content

Commit

Permalink
Video proofread package integration
Browse files Browse the repository at this point in the history
  • Loading branch information
ankit-ekstep committed Mar 9, 2021
1 parent 475d9b6 commit e80e25d
Show file tree
Hide file tree
Showing 13 changed files with 241 additions and 228 deletions.
16 changes: 7 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,17 @@
## Videowiki Proofread web component
`<vw-proofread></vw-proofread>`
## COMET Video Proofread web component
`<vd-proofread></vd-proofread>`

This web component is part of www.videowiki.org and used for the proofreading stage
This web component is part of comet.anuvaad.org and used for the proofreading stage

### Usage:
##### Include the following script in you page
`<script src="https://videowiki-microapps.s3-eu-west-1.amazonaws.com/vw-proofread/v1.0.0.js" async />`

Use the web component `vw-proofread` anywhere on the page with the following properties
Use the web component `vd-proofread` anywhere on the page with the following properties

`<vw-proofread apiKey="" apiRoot="" videoId="" backRoute="" finishRedirectRoute="" </vw-proofread>`
`<vd-proofread apiKey="" apiRoot="" videoId="" backRoute="" finishRedirectRoute="" </vd-proofread>`
`
### Properties
- apiKey: Obtain an API key for your organization from the dashboard on www.videowiki.org
- apiRoot: The API to which the component will communicate, for integration with videowiki's original API use https://api.videowiki.org/api
- apiKey: Obtain an API key for your organization from the dashboard on comet.anuvaad.org
- apiRoot: The API to which the component will communicate, for integration with COMET's original API use https://comet.anuvaad.org.org/api
- videoId: the `_id` field of the video that is to be proofread
- backRoute: the location/route to which the component should redirect when the user press "Back to videos" button.
- finishRedirectRoute: The location/route to which the component should redirect when the user press "Save and complete" button.
2 changes: 1 addition & 1 deletion dist/index.js

Large diffs are not rendered by default.

14 changes: 11 additions & 3 deletions dist/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@videowiki/vw-proofread",
"name": "@comet-anuvaad/video-proofread",
"description": "This project is created using Direflow",
"version": "3.5.2",
"version": "1.0.0",
"scripts": {
"start": "react-app-rewired start",
"build": "react-app-rewired build",
Expand Down Expand Up @@ -63,5 +63,13 @@
"last 1 safari version"
]
},
"config-overrides-path": "direflow-webpack.js"
"config-overrides-path": "direflow-webpack.js",
"repository": {
"type": "git",
"url": "git+https://github.com/project-anuvaad/COMET-proofread.git"
},
"license": "ISC",
"bugs": {
"url": "https://github.com/project-anuvaad/COMET-proofread/issues"
}
}
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 11 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@videowiki/vw-proofread",
"name": "@comet-anuvaad/video-proofread",
"description": "This project is created using Direflow",
"version": "3.5.2",
"version": "1.0.0",
"scripts": {
"start": "react-app-rewired start",
"build": "react-app-rewired build",
Expand Down Expand Up @@ -63,5 +63,13 @@
"last 1 safari version"
]
},
"config-overrides-path": "direflow-webpack.js"
"config-overrides-path": "direflow-webpack.js",
"repository": {
"type": "git",
"url": "git+https://github.com/project-anuvaad/COMET-proofread.git"
},
"license": "ISC",
"bugs": {
"url": "https://github.com/project-anuvaad/COMET-proofread/issues"
}
}
4 changes: 2 additions & 2 deletions public/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@
</head>

<body>
<vw-proofread
<vd-proofread
apiKey="be0a44fb-c1a1-4b5d-9555-9c6ec054472d-1595480004046"
apiRoot="http://localhost:4000/api"
videoId="5f3a10773c3fe9001f5d6064"
websocketServerUrl="ws://localhost:4010"
>
</vw-proofread>
</vd-proofread>
</body>
</html>

Loading

0 comments on commit e80e25d

Please sign in to comment.