Skip to content

Commit

Permalink
add project
Browse files Browse the repository at this point in the history
  • Loading branch information
hassanamin994 committed Feb 29, 2020
0 parents commit 23f664b
Show file tree
Hide file tree
Showing 39 changed files with 25,706 additions and 0 deletions.
31 changes: 31 additions & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{
"env": {
"browser": true,
"es6": true,
"node": true
},
"settings": {
"pragma": "React",
"version": "detect"
},
"extends": [
"eslint:recommended",
"plugin:react/recommended"
],
"globals": {
"Atomics": "readonly",
"SharedArrayBuffer": "readonly"
},
"parserOptions": {
"ecmaFeatures": {
"jsx": true
},
"ecmaVersion": 2018,
"sourceType": "module"
},
"plugins": [
"react"
],
"rules": {
}
}
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
build/
node_modules/
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## Videowiki Proofread web component
`<vw-proofread></vw-proofread>`

This web component is part of www.videowiki.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

`<vw-proofread apiKey="" apiRoot="" videoId="" backRoute="" finishRedirectRoute="" </vw-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
- 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.
10 changes: 10 additions & 0 deletions direflow-webpack.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
const webpackConfig = require('direflow-component/config-overrides');

/**
* Webpack configuration for Direflow Component
* Additional webpack plugins / overrides can be provided here
*/
module.exports = (config, env) => ({
...webpackConfig(config, env),
// Add your own webpack config here (optional)
});
Loading

0 comments on commit 23f664b

Please sign in to comment.