README.md

The dashboard for developers 💻

Table of Contents

• Usage
• Plugins
• Motivation
• Contributing
• Thanks
• Troubleshooting
• License

Usage

For security reason please make sure you are in a secure network.

Installation

npx @dash4/cli

manual installation

Start the dashboard

run npm run dash4 or yarn dash4 if you are using yarn

SSL

dash4.config.js

const fs = require('fs');

async function getConfig() {
  return {
    tabs: ...,
    cert: {
      key: fs.readFileSync('key.pem', 'utf8'),
      cert: fs.readFileSync('cert.pem', 'utf8'),
    },
  };
}

module.exports = getConfig;

Plugins

Official plugins

Name	Version
PluginTerminal
PluginNpmScripts
PluginReadme
PluginCodeCoverage
PluginDependencies
PluginActions

Community plugins

Your wrote a plugin for Dash4? Feel free to add PR with your plugin in this list.

Planned plugins

Name
PluginBundleSize	⌛Coming soon
PluginEmbed	⌛Coming soon
PluginTodos	⌛Coming soon
PluginNote	⌛Coming soon
PluginGitBranch	💡Idea
PluginLighthouse	💡Idea
PluginTypescriptCoverage	💡Idea
PluginCommitizen	💡Idea

Motivation

You are right there are a lot of web dashboards out there. So why is another one needed now? When a new larger project starts, it's usually a mono repository nowadays. Which is great, but has the disadvantage that each package has its own scripts, which makes the project slightly confusing. Dash4 claims to solve this problem because it was designed for mono repositories from the scratch. Another important aspect is extensibility. Dash4 is implemented with and for plugins. Almost everything is a plugin which is why it allows you to add any feature you desire. Dash4 was heavily inspired by webdash and hyper. From technical point of view, the most important technologies which are used in Dash4 are react, websockets, node-pty and Xterm.

Contributing

Contributions to Dash4 are welcome!

• Read our contributing guide to get started.
• Stars ⭐ and Pull requests 📝 are always welcome.

Thanks

• Microsoft - node-pty for node-pty the pseudoterminal in Node.Js
• Xterm for bringing the terminal to the frontend
• Zeit - hyper for the implementation of xterm in react
• JoubranJad - webdash for the inspiration

Troubleshooting

Can't find Python executable "python" on windows window-build-tools/issues/56

License

Dash4 is MIT licensed