@nzz/q-cli 1.10.3 → 2.0.0-beta.10

package/skeletons/server-skeleton/package.json

@@ -1,29 +0,0 @@
-{
-  "name": "server-skeleton",
-  "version": "1.0.0",
-  "description": "Q-Server skeleton",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "author": "",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/github/server-skeleton.git"
-  },
-  "dependencies": {
-    "@hapi/boom": "^9.1.2",
-    "@hapi/bounce": "^2.0.0",
-    "@hapi/h2o2": "^9.0.2",
-    "@hapi/hapi": "^20.1.3",
-    "@nzz/q-server": "^10.0.5",
-    "brok": "^5.0.1",
-    "btoa": "^1.2.1",
-    "confidence": "5.0.0",
-    "hapi-auth-bearer-token": "^8.0.0",
-    "hapi-swagger": "^14.1.3",
-    "joi": "^17.4.0",
-    "nano": "^9.0.3"
-  }
-}

package/skeletons/tool-skeleton/.dockerignore

@@ -1 +0,0 @@
-node_modules

package/skeletons/tool-skeleton/.nvmrc

@@ -1 +0,0 @@
-16

package/skeletons/tool-skeleton/.travis.yml

@@ -1,26 +0,0 @@
-dist: trusty
-sudo: true
-services:
-  - docker
-language: node_js
-node_js:
-  - "16"
-cache:
-  directories:
-    - node_modules
-install:
-  - npm install
-before_script:
-  # TODO: Rename 'q-your-tool' to 'q-<tool-name>'
-  - DOCKER_IMAGE_NAME="q-your-tool"
-  - DOCKER_TAG=${TRAVIS_BRANCH//[^a-zA-Z0-9\_\-\.]/_}
-script:
-  - npm run build
-  - npm run test
-  - 'if [ "$TRAVIS_PULL_REQUEST" = "false" ]; then docker build -t $DOCKER_IMAGE_NAME:$DOCKER_TAG .; fi'
-after_success:
-  - 'if [ "$TRAVIS_PULL_REQUEST" = "false" ]; then echo $DOCKER_PASSWORD | docker login -u="$DOCKER_USERNAME" --password-stdin; docker tag $DOCKER_IMAGE_NAME:$DOCKER_TAG nzzonline/$DOCKER_IMAGE_NAME:$DOCKER_TAG; docker push nzzonline/$DOCKER_IMAGE_NAME:$DOCKER_TAG; fi'
-# TODO: Create token for slack notifications with the slack bot, then insert below & uncomment lines
-# notifications:
-# slack:
-# secure: <Slack-Token>

package/skeletons/tool-skeleton/.vscode/settings.json

@@ -1,5 +0,0 @@
-{
-  "[svelte]": {
-    "editor.defaultFormatter": "svelte.svelte-vscode"
-  }
-}

package/skeletons/tool-skeleton/Dockerfile

@@ -1,19 +0,0 @@
-# Use following version of node alpine as the base image
-FROM node:16-alpine
-
-# Set work directory for run/cmd
-WORKDIR /app
-
-# Copy package.json and package-lock.json into work directory and install dependencies
-COPY package.json /app/package.json
-COPY package-lock.json /app/package-lock.json
-RUN npm install --production
-
-# Copy everthing else in work directory
-COPY . /app
-
-# Expose server port
-EXPOSE 3000
-
-# Run node
-CMD node index.js

package/skeletons/tool-skeleton/LICENSE

@@ -1,20 +0,0 @@
-MIT License
-
-Copyright (c) 2021 NZZ
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/skeletons/tool-skeleton/README.md

@@ -1,104 +0,0 @@
-# tool-skeleton <travis-badge>
-
-**maintainer**: <maintainer>
-
-Short description of tool and link to either [demo](https://editor.q.tools/) or [playground](https://q-playground.st.nzz.ch).
-
-## Table of contents
-
-- [Installation](#installation)
-- [Configuration](#configuration)
-- [Development](#development)
-- [Testing](#testing)
-- [Deployment](#deployment)
-- [Functionality](#functionality)
-- [License](#license)
-
-## Installation
-
-```
-git clone git@github.com:nzzdev/tool-skeleton.git
-cd ./tool-skeleton
-nvm use
-npm install
-npm run build
-```
-
-[to the top](#table-of-contents)
-
-## Configuration
-
-If env variables, explained here
-
-## Development
-
-Start the Q dev server:
-
-```
-npx @nzz/q-cli server
-```
-
-Run the Q tool:
-
-```
-npm run dev
-```
-
-[to the top](#table-of-contents)
-
-## Testing
-
-The testing framework used in this repository is [Code](https://github.com/hapijs/code).
-
-Run the tests:
-
-```
-npm run test
-```
-
-### Implementing a new test
-
-When changing or implementing...
-
-- A `route`, it needs to be tested in the `e2e-tests.js` file
-- Something on the frontend, it needs to be tested in the `dom-tests.js` file
-
-[to the top](#table-of-contents)
-
-## Deployment
-
-We provide automatically built docker images at https://hub.docker.com/r/nzzonline/tool-skeleton/.
-There are three options for deployment:
-
-- Use the provided images
-- Build your own docker images
-- Deploy the service using another technology
-
-### Use the provided docker images
-
-1. Deploy `nzzonline/tool-skeleton` to a docker environment
-2. Set the ENV variables as described in the [configuration section](#configuration)
-
-[to the top](#table-of-contents)
-
-## Functionality
-
-The tool structure follows the general structure of each Q tool. Further information can be found in [Q server documentation - Developing tools](https://nzzdev.github.io/Q-server/developing-tools.html).
-
-Here are all features listed which will have an impact on the tool but are not options. For example spacing issues. If there's a visual aspect, a printscreen would be nice.
-The printscreen can be implemented as following:
-<img src="/doc/card-layout.png" align="right" width=300 height=355>
-
-[to the top](#table-of-contents)
-
-### Options
-
-All options should be listed and explained. The varieties should be listed. If there's a visual aspect, a printscreen would be nice. The options should be listed as they are named in the `schema`
-The printscreen can be implemented as following:
-<img src="/doc/card-layout.png" align="right" width=300 height=355>
-
-[to the top](#table-of-contents)
-
-## License (if open source)
-
-Adding the license + updating the year.

package/skeletons/tool-skeleton/index.js

@@ -1,32 +0,0 @@
-const Hapi = require("@hapi/hapi");
-const Joi = require("joi");
-
-const server = Hapi.server({ port: process.env.PORT || 3000 });
-server.validator(Joi);
-
-const routes = require("./routes/routes.js");
-
-async function init() {
-  await server.register(require("@hapi/inert"));
-  server.route(routes);
-  await server.start();
-  console.log("server running ", server.info.uri);
-}
-
-async function gracefullyStop() {
-  console.log("stopping hapi server");
-  try {
-    await server.stop({ timeout: 10000 });
-    console.log("hapi server stopped");
-  } catch (err) {
-    console.log(err);
-    process.exit(1);
-  }
-  process.exit(0);
-}
-
-// listen on SIGINT and SIGTERM signal and gracefully stop the server
-process.on("SIGINT", gracefullyStop);
-process.on("SIGTERM", gracefullyStop);
-
-init();