Giter Club home page Giter Club logo

dashpub's Introduction

Dashboard Publisher

EXPERIMENTAL tool that creates a Next.js project for a given list of Splunk dashboards, optionally making the dashboards accessible to anyone using Vercel. Search results are proxied through serverless functions, which handle authentication and efficient CDN caching.

Prerequisites

  • Node.js 12+, NPM, Yarn
  • Vercel CLI if you want to publish on Vercel

Get started

  1. Install dashpub CLI globally
$ npm i -g @splunk/dashpub
  1. Initialize a new project
$ dashpub init

Follow the instructions to create your dashboard project.

Copyright 2020 Splunk Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

dashpub's People

Contributors

dependabot[bot] avatar livehybrid avatar ryanwoconnor avatar ziegfried avatar

Stargazers

avatar avatar avatar

Watchers

avatar

dashpub's Issues

Multiple lint issues in preset.js 

./src/preset.js
23:45  Warning: Component definition is missing display name  react/display-name
47:18  Warning: Do not access Object.prototype method 'hasOwnProperty' from target object.  no-prototype-builtins

Getting ERR_INVALID_ARG_TYPE error when running cli 

Error reading directory: TypeError [ERR_INVALID_ARG_TYPE]: The "path" argument must be of type string or an instance of Buffer or URL. Received undefined
    at readdir (node:fs:1460:10)
    at go$readdir (/usr/local/lib/node_modules/@splunk/dashpub/node_modules/graceful-fs/graceful-fs.js:206:16)
    at Object.readdir (/usr/local/lib/node_modules/@splunk/dashpub/node_modules/graceful-fs/graceful-fs.js:211:12)
    at /usr/local/lib/node_modules/@splunk/dashpub/node_modules/universalify/index.js:9:12
    at new Promise (<anonymous>)
    at Object.readdir (/usr/local/lib/node_modules/@splunk/dashpub/node_modules/universalify/index.js:7:14)
    at findCustomVizJsFilesInDirectory (/usr/local/lib/node_modules/@splunk/dashpub/cli/init.js:54:32)
    at initNewProject (/usr/local/lib/node_modules/@splunk/dashpub/cli/init.js:192:27)
    at async main (/usr/local/lib/node_modules/@splunk/dashpub/cli/cli.js:33:9) {
  code: 'ERR_INVALID_ARG_TYPE'
}

Allow running as dev in docker instead of building each time

It is sometimes necessary to run yarn dev instead of building the entire site and starting, for example during development within the docker container.
Allowing for a variable ENV_MODE to be set to dev would make the container run yarn dev instead of a full yarn build/start after the initial setup.
Note, for this the first boot would behave as normal but after a docker restart it could come back as dev mode.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.