Merge pull request #22 from metricq/feat-github-packages

GitHub npm packages

.github/workflows/release.yml

@@ -0,0 +1,25 @@
+name: Publish package to GitHub Packages
+on:
+  release:
+    types: [created]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - uses: actions/checkout@v2
+      # Setup .npmrc file to publish to GitHub Packages
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '16.x'
+          registry-url: 'https://npm.pkg.github.com'
+          # Defaults to the user or organization that owns the workflow file
+          scope: '@metricq'
+      - run: npm publish history/
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - run: npm publish live/
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.npmignore

@@ -0,0 +1,5 @@
+.github/
+.idea/
+dist/
+webpack.config.js
+*_example.html

README.md

@@ -0,0 +1,30 @@
+# metricq-js
+
+## Install via npm/yarn
+
+Add the following line to your `.npmrc` in the project root:
+
+```
+@metricq:registry=https://npm.pkg.github.com
+```
+
+After that install via
+
+```bash
+npm install @metricq/live
+or
+npm install @metricq/history
+```
+
+```bash
+yarn add @metricq/live
+or
+yarn add @metricq/history
+```
+
+## Usage
+
+```js
+import MetricQHistory from "@metricq/history"
+import MetricQLive from "@metricq/live"
+```

history/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@metricq/history",
+  "version": "3.0.0",
+  "description": "MetricQ is a highly-scalable, distributed metric data processing framework based on RabbitMQ. This package provides a client library for the metricq-grafana endpoint.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/metricq/metricq-js.git",
+    "directory": "history"
+  },
+  "main": "./metricq-history.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "Mario Bielert <[email protected]>",
+  "license": "BSD-3-Clause",
+  "dependencies": {
+    "axios": "^0.21.2",
+    "moment": "^2.29.1"
+  },
+  "devDependencies": {
+  },
+  "browser": {
+    "child_process": false
+  },
+  "publishConfig": {
+    "registry": "https://npm.pkg.github.com"
+  }
+}

history_example.js

@@ -1,4 +1,4 @@
-var MetricQHistory = require('./src/metricq-history.js')
+var MetricQHistory = require('./history/metricq-history.js')
 var moment = require('moment')
 
 var mq = new MetricQHistory('https://grafana.metricq.zih.tu-dresden.de/metricq')

live/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@metricq/live",
+  "version": "3.0.0",
+  "description": "MetricQ is a highly-scalable, distributed metric data processing framework based on RabbitMQ. This package provides a client library for the metricq-sink-websocket endpoint.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/metricq/metricq-js.git",
+    "directory": "live"
+  },
+  "main": "./metricq-live.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "Mario Bielert <[email protected]>",
+  "license": "BSD-3-Clause",
+  "dependencies": {
+    "moment": "^2.29.1",
+    "websocket": "^1.0.33"
+  },
+  "devDependencies": {
+  },
+  "browser": {
+    "child_process": false
+  },
+  "publishConfig": {
+    "registry": "https://npm.pkg.github.com"
+  }
+}

live_example.js

@@ -1,4 +1,4 @@
-var MetricQLive = require('./src/metricq-live.js')
+var MetricQLive = require('./live/metricq-live.js')
 
 MetricQLive.connect('wss://websocket.metricq.zih.tu-dresden.de').then(ws => {
   ws.onData = (metric, time, value) => {