-
Notifications
You must be signed in to change notification settings - Fork 70
About webdash
Webdash is a web dashboard that helps developers visualize different aspects of their web applications.
Q: Can't I just do everything from the terminal?
A: Yes, you can. But it's 2018 and not everyone on your team is comfortable in the terminal.
Here are some of the benefits of using Webdash:
- Helps your team members visualize complicated aspects of your project
- Gives you a standard UI that you can rely on
- Gives you a dashboard that you can extend with your own custom plugins
Webdash's front-end is built using Web Components written in Polymer 2. Moreover, every webdash plugin's front-end is a Web Component written in Polymer 2.
Webdash's back-end consists of an express API. Every webdash plugin can also have its own express API that requires you to simply define your own endpoints.
At the time being, we still rely on Bower as it's the only way to get Polymer 2 work.
However, Polymer 3 is right around the corner, and we will updating webdash to Polymer 3.0 as soon as it becomes possible. This will replace HTML Imports & Bower with ES imports & npm/yarn.
Webdash stores its configuration in webdash.json
which is automatically generated upon install.
The installer will try to guess the correct paths based on your project, however you may need to manually update them sometimes. If you think webdash should've correctly guessed a certain configuration option, then please open a new issue.
Here's an example webdash.json
:
{
"src": "./src/",
"dist": "./dist/",
"jsBudgetLimit": 200,
"jsBudgetPath": "./dist/js/*.js",
"manifestPath": "./dist/assets/favicons/manifest.json",
"readableAssets": {
"./src/assets/": "/assets/"
}
}