Universal Dashboard
Documentation, Licensing, Live Preview, YouTube Videos, Forums, Changelog
Create beautiful websites and dashboards using only PowerShell
License
The Universal Dashboard project and module are licensed under the GNU Lesser General Public License.
Install
To install Universal Dashboard, you can use the following PowerShell command.
Install-Module UniversalDashboard
To install Universal Dashboard Community Edition. you can use the following PowerShell command.
Install-Module UniversalDashboard.Community
Key Features
- PowerShell module to develop cross-platform, web-based dashboards
- Built in security using forms and OAuth
- Runs anywhere PowerShell Core and Windows PowerShell are available
- Simple syntax to generate client and server side code
- Generate REST APIs with only PowerShell
- Extreme customization
Examples
Chatroom
Chat room created complete in Universal Dashboard
UDBGInfo
BGInfo clone built using Universal Dashboard to display computer metrics.
Clock
Clock implementation built using SVG and Universal Dashboard.
Nightly Builds
To install nightly builds, you can use the ./tools/install-nightly.ps1 script.
Installing Community Edition
./tools/install-nightly.ps1
Installing Enterprise Edition
./tools/install-nightly.ps1 -Enterprise
Installing into the PowerShell Core Module Path
./tools/install-nightly.ps1 -Enterprise -Core
Contribution Rules
Contributions are always welcome! Please follow the below rules.
- Changes that alter the functionality, add features or fix bugs must have a Pester test validating the change.
- Changes that add new parameters or cmdlets must document the cmdlets using or updating a Plaster markdown file.
- PRs will not be accepted if they add functionality that would duplicate Enterprise Edition features or that render them inoperable.
- Issues should include PowerShell, module and browser version. Logs are preferable.
Building Universal Dashboard
Universal Dashboard is a web application built on .NET Core, ASP.NET Core and React. You will need some build tools to get started.
Dependencies
Building
To build the Universal Dashboard release build, run build.ps1 -Configuration Release from the root source directory.
Building and Debugging
Build the UniversalDashboard solution with dotnet build.
dotnet build .\UniversalDashboard.sln
You can also build the .NET components of UD using Visual Studio 2017.
Run the Webpack dev server.
cd .\client
npm run dev
When building your dashboard in debug mode, make sure to use the port 10001. The Webpack dev server will listen on port 10000. If you open the dashboard in your browser, use the 10000 port. See the integration tests for examples.