developer.md

UDS Marketplace Developer Guide

Table of Contents

• UDS Marketplace Developer Guide
  • Table of Contents
  • Prerequisites
  • Environment Setup
  • Development
    • Starting the API Server
    • Starting the UI Dev Server
    • Starting Mono Dev Server
  • Testing
  • Pre-commit Hooks
  • Deployment
    • Deploying a Slim UDS Cluster
  • Additional Notes

Prerequisites

Ensure you have the following tools installed:

• Go
• Node.js
• Docker
• Homebrew
• UDS CLI

Install UDS CLI:

brew tap defenseunicorns/tap
brew install uds

Environment Setup

1. Clone the repository:

   git clone https://github.com/defenseunicorns/uds-marketplace.git
   cd uds-marketplace

2. Install dependencies:

   uds run setup:deps

3. Install environment tools:

   uds run setup:install-tools

Development

Starting the API Server

To run the API server in development mode with hot-reloading:

uds run dev-api

Starting the UI Dev Server

To run the UI in development mode:

uds run dev-ui

Starting Mono Dev Server

To run both the API server and the UI in development mode (hot-reloading):

uds run dev

Testing

To run all tests:

uds run tests

Pre-commit Hooks

uds run pre-commit

Note: may fix formatting and need git add . post pre-commit

Deployment

Deploying a Slim UDS Cluster

To create a k3d cluster and deploy a slim version of UDS with metrics server and marketplace:

uds run k3d-dev-deploy

Additional Notes

• The project uses maru runner via uds run <task>. To view available top level tasks, run uds run --list or uds run --list-all for all tasks.
• For more detailed contribution guidelines, refer to the CONTRIBUTING.md.