@abi-software/scaffoldvuer 0.1.3 → 0.1.5-1.beta.2

package/.eslintrc.js

@@ -0,0 +1,12 @@
+module.exports = {
+  extends: [
+    // add more generic rulesets here, such as:
+    'plugin:vue/recommended', // Use this if you are using Vue.js 2.x.,
+
+  ],
+  rules: {
+    // override/add rules settings here, such as:
+    // 'vue/no-unused-vars': 'error'
+  }
+}
+

package/README.md

@@ -1,2 +1,88 @@
-Scaffoldvuer
-Vue component of the PhysiomePortal Scaffold Viewer
+# Scaffoldvuer
+
+This project aims to provide high-level 3D physiological models viewing capability.
+
+
+## Scaffoldvuer on NPM
+
+Scaffoldvuer is available on npm and can be installed into your project with the following command:
+```bash
+npm i @abi-software/scaffoldvuer
+```
+
+## Project setup
+```
+npm install
+```
+
+### Compiles and minifies for production
+```
+npm run build-bundle
+```
+
+## How to use
+Install the package in your vue app project with the following command "npm i @abi-software/scaffoldvuer".
+Import the package in your script as followed:
+```javascript
+import { ScaffoldVuer } from '@abi-software/scaffoldvuer';
+import '@abi-software/scaffoldvuer/dist/scaffoldvuer.css';
+```
+Local registration in vue component:
+```javascript
+export default {
+  ...
+  components: {
+    ScaffoldVuer,
+  }
+  ...
+}
+```
+
+
+The codes above register the ScaffoldVuer component in the global scope.
+You can now use the ScaffoldVuer in your vue template as followed:
+```html
+<ScaffoldVuer url="Metafile.json" v-on:scaffold-selected="ScaffoldSelected"  style="height:50%"/>
+```
+
+url should be a variable/string containing the url of a compatible json model.
+scaffold-selected is the custom event triggered when a part of the 3D-scaffold is selected, see below for a
+sample callback.
+
+```javascript
+  methods: {
+    ScaffoldSelected: function(annotation) {
+     console.log(annotation);
+    }
+  }
+```
+A more in depth API reference can be found here: https://abi-software.github.io/scaffoldvuer/ .
+
+## Project setup from Github
+
+The source code is available from Github, it can be found here: https://github.com/ABI-Software/scaffoldvuer .
+
+### Clone the respositroy
+```bash
+git clone https://github.com/ABI-Software/scaffoldvuer.git
+```
+
+### Setup
+```bash
+npm install
+```
+
+### Compiles and minifies for production
+```bash
+npm run build-bundle
+```
+
+### Run the sample application
+```bash
+npm run serve
+```
+
+
+## Example
+The following example showcases ScaffoldVuer in action: https://mapcore-demo.org/current/scaffoldvuer/
+

package/babel.config.js

@@ -1,5 +1,14 @@
 module.exports = {
   presets: [
     '@vue/cli-plugin-babel/preset'
+  ],
+  plugins: [
+    [
+      "component",
+      {
+        libraryName: "element-ui",
+        styleLibraryName: "theme-chalk"
+      }
+    ]
   ]
 }