Skip to content
Snippets Groups Projects
README.md 1.18 KiB
Newer Older
  • Learn to ignore specific revisions
  • rhenck's avatar
    rhenck committed
    # Verona Modules Aspect
    
    rhenck's avatar
    rhenck committed
    
    
    Repository for the Aspect Editor and Player. The applications have a shared code base, but can be run and built separately.
    
    Meant to be used in [IQB-Teststudio](https://github.com/iqb-berlin/teststudio-lite-setup) and [IQB-Testcenter](https://github.com/iqb-berlin/testcenter-setup).
    
    rhenck's avatar
    rhenck committed
    
    
    rhenck's avatar
    rhenck committed
    Both conform to the Verona API definition:
    
    rhenck's avatar
    rhenck committed
    
    
    rhenck's avatar
    rhenck committed
    [Editor-API](https://verona-interfaces.github.io/editor/)
    
    rhenck's avatar
    rhenck committed
    
    
    rhenck's avatar
    rhenck committed
    [Player-API](https://verona-interfaces.github.io/player/)
    
    rhenck's avatar
    rhenck committed
    
    
    ## Supported Browsers
    last 1 Chrome version
    
    rhenck's avatar
    rhenck committed
    
    
    last 1 Firefox version
    
    rhenck's avatar
    rhenck committed
    
    
    last 2 Edge major versions
    
    last 2 Safari major versions
    
    last 2 iOS major versions
    
    Firefox ESR
    
    not IE 11
    
    rhenck's avatar
    rhenck committed
    
    
    
    rhenck's avatar
    rhenck committed
    
    
    To build the packages or run the local development environment, first install the NPM packages. You need to have a recent version of node and npm (tested and working with versions: 6,7,8) installed.
    > npm install
    
    ### Run development server
    Run the package on a local development server (this builds the app automatically).
    
    >npm run start-editor-local
    
    rhenck's avatar
    rhenck committed
    
    
    rhenck's avatar
    rhenck committed
    or
    
    rhenck's avatar
    rhenck committed
    
    
    >npm run start-player-local
    
    ### Build
    This produces an HTML file in the `dist` folder, named `verona-{module}-aspect-{version}.html`.
    
    rhenck's avatar
    rhenck committed
    
    
    jojohoch's avatar
    jojohoch committed
    >npm run build-editor
    
    rhenck's avatar
    rhenck committed
    
    
    jojohoch's avatar
    jojohoch committed
    >npm run build-player