Skip to content

Commit

Permalink
Improve documentation and demo
Browse files Browse the repository at this point in the history
Make sure socket io is imported correctly for browser based builds
Cleanups
  • Loading branch information
cristijora committed Jul 2, 2019
1 parent 0c811e4 commit 65452aa
Show file tree
Hide file tree
Showing 10 changed files with 60 additions and 81 deletions.
Binary file removed demo/assets/logo.png
Binary file not shown.
10 changes: 0 additions & 10 deletions demo/main.js

This file was deleted.

76 changes: 42 additions & 34 deletions demo/App.vue → docs/.vuepress/components/Demo.vue
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<template>
<div id="app" class="bg-gray-100 min-h-screen px-20 py-8">
<div id="app" class="min-h-screen py-8">
<div class="flex mb-3 w-full items-end">
<div class="flex-1">
<label>Monitor Code</label>
Expand Down Expand Up @@ -32,53 +32,61 @@
</template>

<script>
import EventsSdk from '../src/index'
export default {
name: 'app',
data() {
return {
events: [],
monitorCode: 'FWsqFkPDsJuuh54YU0VLCvTu5EIrplkrUFVQ7yMiXh7U52hfiNOYanNINtekWBb6X06C3LQR7jfgCCWGAbKKCdBJAeQFIWO3DCCl',
error: ''
}
},
methods: {
async login() {
this.events = []
this.error = ''
try {
let sdk = new EventsSdk({
token: this.monitorCode
})
await sdk.login()
sdk.on('*', data => {
this.events.unshift({
timestamp: new Date(),
...data
})
})
} catch (e) {
this.error = e
import Vue from 'vue';
import EventsSdk from '../../../src';
import TreeView from 'vue-json-tree-view';
Vue.use(TreeView);
export default {
name: 'app',
data() {
return {
events: [],
monitorCode: 'FWsqFkPDsJuuh54YU0VLCvTu5EIrplkrUFVQ7yMiXh7U52hfiNOYanNINtekWBb6X06C3LQR7jfgCCWGAbKKCdBJAeQFIWO3DCCl',
error: ''
};
},
methods: {
async login() {
this.events = [];
this.error = '';
try {
let sdk = new EventsSdk({
token: this.monitorCode
});
await sdk.login();
sdk.on('*', data => {
this.events.unshift({
timestamp: new Date(),
...data
});
});
} catch (e) {
this.error = e;
}
}
},
async mounted() {
this.login();
}
},
async mounted() {
this.login()
}
};
};
</script>

<style>
.list-enter-active, .list-leave-active {
transition: all .4s;
}
.list-leave-active {
position: absolute;
}
.list-enter, .list-leave-to /* .list-leave-active below version 2.1.8 */ {
.list-enter, .list-leave-to /* .list-leave-active below version 2.1.8 */
{
opacity: 0;
transform: translateX(-20px);
}
.list-move {
transition: transform .3s;
}
Expand Down
4 changes: 4 additions & 0 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ module.exports = {
description: 'VoicenterEventsSdk for Vue.js'
}
},
head: [
['link', { rel: 'stylesheet', href: 'https://unpkg.com/tailwindcss@^1.0/dist/tailwind.min.css'}]
],
themeConfig: {
repo: '/voicenter/VoicecenterEventsSDK',
docsDir: 'docs',
Expand All @@ -24,6 +27,7 @@ module.exports = {
sidebar: [
'/installation.md',
'/started.md',
'/demo.md'
]
}
}
Expand Down
3 changes: 3 additions & 0 deletions docs/demo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Demo

<Demo></Demo>
19 changes: 10 additions & 9 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,17 @@
"name": "voicenter-events-sdk",
"version": "0.1.0",
"scripts": {
"serve": "vue-cli-service serve ./demo/main.js",
"build": "vue-cli-service build --target lib --name voicenter-events-sdk src/index.js",
"build:demo": "vue-cli-service build ./demo/main.js",
"serve": "npm run docs",
"build": "vue-cli-service build",
"lint": "vue-cli-service lint",
"docs": "npm run docs:serve",
"docs:build": "vue-cli-service docs --mode build",
"docs:serve": "vue-cli-service docs --mode serve",
"docs": "vue-cli-service docs --mode serve",
"build:docs": "vue-cli-service docs --mode build",
"prepublish": "vue-cli-service lint && vue-cli-service docs --mode build && vue-cli-service build",
"start": "vue-cli-service serve"
"start": "npm run docs"
},
"dependencies": {
"core-js": "^2.6.5"
"core-js": "^2.6.5",
"socket.io-client": "1.3.6"
},
"devDependencies": {
"@vue/cli-plugin-babel": "^3.8.0",
Expand All @@ -22,12 +21,14 @@
"babel-eslint": "^10.0.1",
"eslint": "^5.16.0",
"eslint-plugin-vue": "^5.0.0",
"socket.io-client": "1.3.6",
"vue": "^2.6.10",
"vue-cli-plugin-p11n": "^0.3.0",
"vue-json-tree-view": "^2.1.4",
"vue-template-compiler": "^2.6.10"
},
"peerDependencies": {
"socket.io-client": "1.3.6"
},
"files": [
"dist/voicenter-events-sdk.common.js",
"dist/voicenter-events-sdk.umd.min.js",
Expand Down
Binary file removed public/favicon.ico
Binary file not shown.
18 changes: 0 additions & 18 deletions public/index.html

This file was deleted.

2 changes: 1 addition & 1 deletion src/sdk.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import io from 'socket.io-client'
import io from 'socket.io-client/socket.io'
import eventTypes from './eventTypes'
const defaultOptions = {
url: 'https://monitor5.voicenter.co.il/',
Expand Down
9 changes: 0 additions & 9 deletions vue.config.js
Original file line number Diff line number Diff line change
@@ -1,13 +1,4 @@
let externals = {
'socket.io-client': {
commonjs: 'socket.io-client',
commonjs2: 'socket.io-client',
root: 'io'
}
}
let isProd = process.env.NODE_ENV === 'production'
module.exports = {
configureWebpack: {
externals: isProd ? externals : {}
}
}

0 comments on commit 65452aa

Please sign in to comment.