Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alx9r/structuredresource
Streamlined development of robust and consistent PowerShell DSC resources.
https://github.com/alx9r/structuredresource
automated-tests dsc-resource framework guidelines powershell test-driven-development
Last synced: 10 days ago
JSON representation
Streamlined development of robust and consistent PowerShell DSC resources.
- Host: GitHub
- URL: https://github.com/alx9r/structuredresource
- Owner: alx9r
- License: other
- Created: 2017-10-03T13:55:30.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-01-28T18:36:58.000Z (about 5 years ago)
- Last Synced: 2024-11-19T07:43:18.196Z (2 months ago)
- Topics: automated-tests, dsc-resource, framework, guidelines, powershell, test-driven-development
- Language: PowerShell
- Homepage:
- Size: 171 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Docs/readme.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Getting Started with StructuredResource
## New to PowerShell or DSC?
All of the StructuredResource documentation assumes that you have a working familiarity with PowerShell and DSC. If you are new to PowerShell or DSC, I recommend reviewing the getting started documentation at the [PowerShell](https://github.com/PowerShell/PowerShell) project.
## Installing StructuredResource
StructuredResource is a PowerShell module. To install simply put the root folder (the one named "StructuredResource") in one of the `$Env:PSModulePath` folders on your system. For testing and development I recommend installing StructuredResource to the user modules folder (usually `$Env:UserProfile\Documents\WindowsPowerShell\Modules`).
### Prerequisites
StructuredResource requires WMF 5.0 or later.
### Obtaining StructuredResource
To obtain StructuredResource I recommend cloning [the repository](https://github.com/alx9r/StructuredResource.git) to your computer and checking out the [latest release](https://github.com/alx9r/StructuredResource/releases/latest) using `git clone` and `git checkout`.
Alternatively you can download then extract an archive of the module from [this page](https://github.com/alx9r/StructuredResource/releases/latest).
### Confirming Installation
To confirm that StructuredResource is installed on your computer, invoke the following commands:
```
C:\> Import-Module StructuredResource
C:\> Get-Module StructuredResource
ModuleType Version Name ExportedCommands
---------- ------- ---- ----------------
Script 0.1.0 StructuredResource {Invoke-Structured...
```
You should see some details about the StructuredResource module output by the `Get-Module` command as shown above.
## Tutorial
For an introduction to using StructuredResource to develop your own DSC resources, I recommend following [the tutorial][].
[the tutorial]: tutorial.md