Universal Dashboard Community Edition as a free, open source platform for developing websites in PowerShell. In this post, we’ll go over some of the fundamentals of contributing to the platform from a source code perspective.
To build and run UD in a development environment you will need a couple of prerequisites. Universal Dashboard is built on .NET Core, ASP.NET Core, and React. To build and run the project, you’ll need the following.
To build a release version, you can use the
build.ps1script in the root of the
To build release, use the following command line.
.\build.ps1 -Configuration Release
If you don't want to wait for the help to build, you can use the
-NoHelpscript to skip building the help.
To build in debug mode, you can run
dotnet buildfrom the
To host the UI in the webpack dev server, you can run the npm task as follows.
npm run dev
The webpack dev server will run on port 10000. You should run your
Start-UDDashboardcommands on port 10001.
You can check out the integration tests to see how this is done.
- Cmdlets | Cmdlets exported from Universal Dashboard
- Controllers | WebAPI controllers that serve data to the client
- Controls | PowerShell controls built on New-UDElement
- Execution | Execution engine for endpoints
- Help | Markdown help for cmdlets
- Models | Objects that are serialized and sent down to the client from the server
- Server | ASP.NET Server configuration
- Services | Various services for UD
- Themes | Themes for UD
- Utilities | Various utility classes
- UniversalDashboard.Server | Runs UD as a service and as a console application. Provides IIS support.
- UniversalDashboard.UITest | Pester tests for Universal Dashboard.