Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smollweide/dash4
The dashboard for developers :computer:
https://github.com/smollweide/dash4
browser-terminal dash4 dashboard plugins productivity terminal tools web-dashboard webdash
Last synced: 24 days ago
JSON representation
The dashboard for developers :computer:
- Host: GitHub
- URL: https://github.com/smollweide/dash4
- Owner: smollweide
- License: mit
- Created: 2019-03-01T13:13:50.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-10T08:53:19.000Z (3 months ago)
- Last Synced: 2024-10-09T19:36:42.226Z (2 months ago)
- Topics: browser-terminal, dash4, dashboard, plugins, productivity, terminal, tools, web-dashboard, webdash
- Language: TypeScript
- Homepage:
- Size: 3 MB
- Stars: 21
- Watchers: 3
- Forks: 2
- Open Issues: 66
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
The dashboard for developers :computer:
[](https://travis-ci.org/smollweide/dash4) [](http://opensource.org/licenses/MIT) [](http://commitizen.github.io/cz-cli/) [](https://github.com/prettier/prettier)
## Table of Contents
* [Usage](#usage)
* [Plugins](#plugins)
* [Motivation](#motivation)
* [Contributing](#contributing)
* [Thanks](#thanks)
* [Troubleshooting](#troubleshooting)
* [License](#license)
## Usage
> For security reason please make sure you are in a secure network.
### Installation
```shell
npx @dash4/cli
```
[manual installation](./docs/manual-installation.md)
### Start the dashboard
run `npm run dash4` or `yarn dash4` if you are using yarn
### SSL
_dash4.config.js_
```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](https://github.com/smollweide/dash4/blob/master/plugins/plugin-terminal/README.md) | [](https://www.npmjs.com/package/@dash4/plugin-terminal) |
| [PluginNpmScripts](https://github.com/smollweide/dash4/blob/master/plugins/plugin-npm-scripts/README.md) | [](https://www.npmjs.com/package/@dash4/plugin-npm-scripts) |
| [PluginReadme](https://github.com/smollweide/dash4/blob/master/plugins/plugin-readme/README.md) | [](https://www.npmjs.com/package/@dash4/plugin-readme) |
| [PluginCodeCoverage](https://github.com/smollweide/dash4/blob/master/plugins/plugin-code-coverage/README.md) | [](https://www.npmjs.com/package/@dash4/plugin-code-coverage) |
| [PluginDependencies](https://github.com/smollweide/dash4/blob/master/plugins/plugin-dependencies/README.md) | [](https://www.npmjs.com/package/@dash4/plugin-dependencies) |
| [PluginActions](https://github.com/smollweide/dash4/blob/master/plugins/plugin-actions/README.md) | [](https://www.npmjs.com/package/@dash4/plugin-actions) |
### 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](https://github.com/jadjoubran/webdash) and [hyper](https://github.com/zeit/hyper). From technical point of view, the most important technologies which are used in Dash4 are [react](https://reactjs.org/), [websockets](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API), [node-pty](https://github.com/Microsoft/node-pty) and [Xterm](https://github.com/xtermjs/xterm.js).
## Contributing
Contributions to Dash4 are welcome!
* Read our [contributing guide](https://github.com/smollweide/dash4/blob/master/CONTRIBUTING.md) to get started.
* Stars :star: and Pull requests :pencil: are always welcome.
## Thanks
- [Microsoft - node-pty](https://github.com/Microsoft/node-pty) for `node-pty` the pseudoterminal in Node.Js
- [Xterm](https://github.com/xtermjs/xterm.js) for bringing the terminal to the frontend
- [Zeit - hyper](https://github.com/zeit/hyper) for the implementation of xterm in react
- [JoubranJad - webdash](https://github.com/jadjoubran/webdash) for the inspiration
`Can't find Python executable "python"` on windows
[window-build-tools/issues/56](https://github.com/felixrieseberg/windows-build-tools/issues/56)
## License
Dash4 is [MIT licensed](./LICENSE)