golden-nectar
v0.1.0
Published
Golden Nectar is a project designed to streamline API client generation and deployment workflows. This repository contains PowerShell scripts to automate tasks such as generating API clients and publishing them.
Readme
Golden Nectar (DO NOT SHARE)
Golden Nectar is a project designed to streamline API client generation and deployment workflows. This repository contains PowerShell scripts to automate tasks such as generating API clients and publishing them.
👋 Quickstart
Follow these steps to get started:
Install Required Modules
Ensure you have theps-menumodule installed:Install-Module -Name ps-menuRun the Build Script
Execute the main build script to access the available commands:pwsh ./build.ps1Select a Task
🛠 Prerequisites
Ensure the following tools and dependencies are installed on your system:
PowerShell Core
Install PowerShell Core (pwsh) if not already installed.
Download PowerShell CoreKiota
Kiota is required for generating API clients. Install it globally using the .NET CLI:dotnet tool install --global Kiotaps-menu Module
Install theps-menumodule for interactive menu functionality:Install-Module -Name ps-menu
📂 Project Structure
build.ps1: The main PowerShell script for generating and managing API clients.rubber/network: Directory where generated API clients are stored.README.md: Documentation for the project.
🚀 Usage Example
To generate the Reminding API client:
- Run the build script:
pwsh ./build.ps1 - Select
New reminding clientfrom the menu. - The generated client will be available in the
rubber/network/remindingdirectory.
📝 Notes
- Ensure the OpenAPI specification files are accessible at the paths defined in the script.
- Modify the
build.ps1script if you need to customize the generation process.
📖 Documentation
For more details, refer to the Developer Guide 🧑.
⚠️ Disclaimer
This project is internal and should not be shared outside the organization.
