### Install Dependencies and Start Servers Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/portal/README.md Commands to install dependencies, start the mock API server, and start the portal development server. ```bash npm install npm run start:api npm run start:portal # → http://localhost:4200 ``` -------------------------------- ### Start Services with Docker Compose Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/company-api/README.md Starts the application, database, and search server using Docker Compose. Ensure Docker and Rancher Desktop are installed and configured. ```bash $ cd apps/company-api $ docker-compose up --build ``` -------------------------------- ### Setup Storybook Dependencies Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/docs/tooling/contributing.mdx Execute this command to ensure all necessary Storybook dependencies are installed. ```bash npm run mcp:setup ``` -------------------------------- ### MCP Server Setup and Development Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/CLAUDE.md Commands for setting up, installing dependencies, building, and running the MCP server in development mode for Storybook component generation. ```bash npm run mcp:setup # First-time setup npm run mcp:storybook:install # Install dependencies npm run mcp:storybook:build # Build MCP server npm run mcp:storybook:dev # Development mode ``` -------------------------------- ### Install and Start CockroachDB Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/company-api/README.md Installs CockroachDB using Homebrew and starts it as a service. This provides a local PostgreSQL-compatible database for development. ```bash $ brew install cockroachdb/tap/cockroach $ brew services start cockroachdb/tap/cockroach ``` -------------------------------- ### Install Dependencies Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/README.md Command to install all project dependencies. ```bash npm install ``` -------------------------------- ### Installation and Development Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/tools/storybook-mcp/README.md Instructions for installing, building, and developing the Storybook MCP Server. ```APIDOC ## Installation and Development ### Installation To install the MCP server, navigate to the `tools/storybook-mcp` directory and run the following commands: ```bash cd tools/storybook-mcp npm install npm run build ``` ### Development For development purposes, you can use the watch mode: ```bash # Watch mode for development npm run dev ``` To build the project for production: ```bash # Build for production npm run build ``` ``` -------------------------------- ### Start Portal Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/README.md Starts the Vite development server for the portal on port 4200. ```bash npm run start:portal ``` -------------------------------- ### Install Docker Emulation Support Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/opcofin/README.md Install support for multi-architecture emulation in Docker. ```shell docker run --privileged --rm tonistiigi/binfmt --install all ``` -------------------------------- ### Install UI Package Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/libs/shared/ui/src/lib/button/button.mdx Install the required package to access the Button component. ```bash npm install] @redesignhealth/ui ``` -------------------------------- ### Install and Build MCP Server Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/tools/storybook-mcp/README.md Commands to set up the MCP server environment. ```bash cd tools/storybook-mcp npm install npm run build ``` -------------------------------- ### Install Java 17 with Homebrew Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/company-api/README.md Installs Java 17 using Homebrew. Ensure you have Homebrew installed and tap the `homebrew/cask-versions` repository. ```bash $ brew tap homebrew/cask-versions $ brew install --cask temurin17 ``` -------------------------------- ### Start API Server Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/README.md Starts the Express mock server on port 8080. ```bash npm run start:api ``` -------------------------------- ### Install @redesignhealth/ui Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/libs/shared/ui/src/lib/menu/README.md Install the UI package using yarn or npm. ```sh yarn add @redesignhealth/ui # or npm i @redesignhealth/ui ``` -------------------------------- ### Configure Jest global setup Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/docs/tooling/testing.mdx The setup file runs before every test suite to provide DOM matchers and polyfill necessary globals. ```js import '@testing-library/jest-dom' // Polyfill TextEncoder/TextDecoder for JSDOM import { TextEncoder, TextDecoder } from 'util' Object.assign(global, { TextDecoder, TextEncoder }) ``` -------------------------------- ### Initialize forgekit-nx-storybook Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/tools/forgekit-nx-storybook/README.md Install the plugin locally or via npm to begin generating stories. ```bash npx nx g ./tools/forgekit-nx-storybook:init ``` ```bash npx nx add forgekit-nx-storybook ``` -------------------------------- ### Start the development server Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/docs/applications/parser-playground.mdx Launches the Vite development server with hot module replacement enabled. ```bash nx serve parser-playground ``` -------------------------------- ### Install Redesign UI Icons Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/docs/design-system/media-and-icons/icon.md Commands to install the UI package via npm or yarn. ```bash npm i @redesignhealth/ui # or yarn add @redesignhealth/ui ``` -------------------------------- ### Install dependencies Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/docs/getting-started.mdx Install all project dependencies from the repository root using npm with the legacy peer dependencies flag. Ensure you do not install packages within individual apps or libraries. ```bash npm install --legacy-peer-deps ``` -------------------------------- ### Configure Vitest global setup Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/docs/tooling/testing.mdx This setup file extends Vitest expectations with DOM matchers and mocks global browser APIs required for UI components. ```ts import matchers from '@testing-library/jest-dom/matchers' import { expect, vi } from 'vitest' vi.stubGlobal('matchMedia', matchMediaMock) expect.extend(matchers) ``` -------------------------------- ### Start Local Development Stack Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/docs/backend/services.mdx Use this command to start all services defined in the Docker Compose file for local development. Ensure Docker is running. ```bash docker-compose up ``` -------------------------------- ### Install dependencies Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/docs/tooling/contributing.mdx Install packages at the root level using the required legacy peer dependency flag. ```bash npm install --legacy-peer-deps npm install -D --legacy-peer-deps ``` -------------------------------- ### Conventional Commit Examples Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/docs/tooling/contributing.mdx Provides examples of conventional commit messages, including type, scope, and summary. These examples cover various scenarios like adding features, fixing bugs, and updating dependencies. ```text feat(portal): add company search filters to dashboard fix(shared-ui): resolve button focus ring not visible in dark mode chore(deps): update @tanstack/react-query to 5.0.0 docs(contributing): add commit convention examples refactor(data-assets): extract company API hooks to separate file test(ceo-directory): add unit tests for sort and filter logic ``` -------------------------------- ### Install Maven with Homebrew Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/company-api/README.md Installs Maven using Homebrew. This is a prerequisite for building the Java project. ```bash $ brew install maven ``` -------------------------------- ### Run Storybook Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/docs/getting-started.mdx Start Storybook to view and develop UI components in isolation. ```bash npm run storybook ``` -------------------------------- ### Initialize forgekit-nx-storybook plugin Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/docs/tooling/development-tools.mdx Installs the plugin and ensures necessary Storybook dependencies are present. ```bash npx nx g forgekit-nx-storybook:init ``` -------------------------------- ### Environment Variables Configuration Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/README.md Example configuration for the portal environment variables. ```ini VITE_COMPANY_API_HOSTNAME=http://localhost:8080 VITE_GOOGLE_CLIENT_ID=.apps.googleusercontent.com VITE_GA4_MEASUREMENT_ID=G-XXXXXXXXXX # optional VITE_HOTJAR_ID=XXXXXXX # optional ``` -------------------------------- ### Run all Storybooks Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/docs/tooling/development-tools.mdx Executes the command to start all configured Storybook instances simultaneously. ```bash npm run storybook-all ``` -------------------------------- ### Branch Naming Examples Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/docs/tooling/contributing.mdx Shows examples of branch names following the conventional commit prefixes for features, fixes, chores, docs, and refactors. ```text feature/company-search-filters fix/button-focus-ring chore/update-react-query ``` -------------------------------- ### Install Jira Rest Client Library Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/company-api/doc/architecture/decisions/0008-jira-rest-client.md Install the generated Jira rest client library to your local Maven repository. This makes it available to other modules in the monorepo. ```bash $ mvn clean install -pl jira-rest-client ``` -------------------------------- ### Run Prometheus Server Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/prometheus/README.md Start the Prometheus container and map port 9090. ```bash $ docker run -p 9090:9090 prometheus ``` -------------------------------- ### Basic Input Usage Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/docs/design-system/form/input.md A basic example of using the Input component with a placeholder. ```jsx ``` -------------------------------- ### Start the development server Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/docs/getting-started.mdx Launch the development server for the portal application. The portal will be accessible at http://localhost:4200 by default. ```bash npm start ``` -------------------------------- ### Paginated Company List Request Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/docs/backend/api-reference.mdx Example of a GET request to retrieve a paginated list of companies. It demonstrates the use of query parameters for pagination (page, size) and sorting (sort). ```bash GET /company?page=0&size=20&sort=name,asc ``` -------------------------------- ### Company API Root Response Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/company-api/README.md Example response from the Company API root endpoint (GET http://localhost:8080). It includes links to API documentation and core company values. ```json { "_links": { "documentation": { "href": "http://localhost:8080/public/docs" }, "swagger": { "href": "http://localhost:8080/public/swagger" }, "openApi": { "href": "http://localhost:8080/public/open-api" } }, "Redesign Health": { "Own the outcome": "We do the work to get the job done", "Learn continuously": "We focus on constantly growing as individuals and as a team", "Redesign Healthcare": "We bring positive change to patients' lives", "Be trusted partners": "We strive to be the teammates and co-founders of choice", "Champion diverse perspectives": "We work to unlock our joint potential", "Practice kindness": "We aim to build bridges, not walls" } } ``` -------------------------------- ### Run build and serve commands Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/docs/applications/third-party-network.mdx Commands for serving the application locally or building for specific environments. ```bash # Serve locally nx serve third-party-network # Build for staging nx build third-party-network --configuration=staging # Build for production nx build third-party-network --configuration=prod ``` -------------------------------- ### Menu with Letter Navigation Example Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/libs/shared/ui/src/lib/menu/README.md Demonstrates a menu configured for letter navigation. Typing a letter while the menu is open or focused will move focus to the first menu item starting with that letter. ```jsx File New File New Window Open... Save File ``` -------------------------------- ### Create Mobile Spinner with useNumberInput Hook Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/libs/shared/ui/src/lib/number-input/README.md Leverage the `useNumberInput` hook to build a custom mobile-friendly number input spinner. This example demonstrates how to get props for the input, increment, and decrement buttons. ```jsx function HookUsage() { const { getInputProps, getIncrementButtonProps, getDecrementButtonProps } = useNumberInput({ step: 0.01, defaultValue: 1.53, min: 1, max: 6, precision: 2 }) const inc = getIncrementButtonProps() const dec = getDecrementButtonProps() const input = getInputProps() return ( ) } ``` -------------------------------- ### Serve Portal with Command Line Variables Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/portal/README.md How to serve the portal with environment variables set directly on the command line. ```bash VITE_COMPANY_API_HOSTNAME=https://staging-api.example.com nx run portal:serve ``` -------------------------------- ### Serve frontend applications with Nx Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/docs/applications/overview.mdx Execute these commands from the repository root to start the development servers for specific applications. ```bash npm start # Serves the Portal (default project) nx serve third-party-network # Serves the third-party network app nx serve parser-playground # Serves the parser playground ``` -------------------------------- ### GET /category/query Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/company-api/application/src/docs/asciidoc/categories.adoc Get all categories. Requires ROLE_OP_CO_USER role. ```APIDOC ## GET /category/query ### Description Get all categories. ### Method GET ### Endpoint /category/query ### Parameters #### Query Parameters - **limit** (integer) - Optional - The maximum number of categories to return. - **offset** (integer) - Optional - The number of categories to skip. ### Response #### Success Response (200) - **categories** (array) - A list of category objects. - **id** (string) - The unique identifier of the category. - **name** (string) - The name of the category. - **description** (string) - The description of the category. #### Response Example ```json { "categories": [ { "id": "cat-123", "name": "Electronics", "description": "Gadgets and electronic devices" }, { "id": "cat-456", "name": "Books", "description": "Printed and digital books" } ] } ``` ``` -------------------------------- ### GET /category/get Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/company-api/application/src/docs/asciidoc/categories.adoc Get one category. Requires ROLE_OP_CO_USER role. ```APIDOC ## GET /category/get ### Description Get one category. ### Method GET ### Endpoint /category/get ### Parameters #### Query Parameters - **id** (string) - Required - The ID of the category to retrieve. ### Response #### Success Response (200) - **id** (string) - The unique identifier of the category. - **name** (string) - The name of the category. - **description** (string) - The description of the category. #### Response Example ```json { "id": "cat-123", "name": "Electronics", "description": "Gadgets and electronic devices" } ``` ``` -------------------------------- ### Build Application and Generate Docs Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/company-api/README.md Cleans the project, packages the application, and generates documentation. Ensure tests are not skipped. ```bash $ mvn clean package -pl application ``` -------------------------------- ### Build portal Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/docs/getting-started.mdx Build the portal application for production. ```bash npm run build:portal ``` -------------------------------- ### Create New Mkdocs Site Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/docs/readme.md Use this command to initialize a new Mkdocs project in your local environment. Ensure you have Mkdocs installed. ```bash Mkdocs new site-name ``` -------------------------------- ### GET /companies/{id}/conflicts Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/company-api/application/src/docs/asciidoc/company.adoc Get the list of companies with which this company has conflicts. ```APIDOC ## GET /companies/{id}/conflicts ### Description Get the list of the companies with which one this company has conflicts. ### Method GET ### Endpoint /companies/{id}/conflicts ``` -------------------------------- ### Start local backend stack with Docker Compose Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/docs/tooling/deployment.mdx Use this command to initialize the local development environment for the Company API and its dependencies. ```bash cd apps/company-api docker-compose up ``` -------------------------------- ### Run Default Application Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/CLAUDE.md Serves the default application (portal) using npm start. Nx automatically locates and runs the correct project. ```bash npm start # Serves default project (portal) ``` -------------------------------- ### Running Tests Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/libs/portal/utils/README.md Execute the test suite for the portal-utils package using Nx. ```bash nx test portal-utils ``` -------------------------------- ### GET /company-vendor/{id} Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/company-api/application/src/docs/asciidoc/company-vendor.adoc Get information about how a Company uses a specific vendor. Requires ROLE_OP_CO_USER. ```APIDOC ## GET /company-vendor/{id} ### Description Get information about how a Company uses a specific vendor. ### Method GET ### Endpoint /company-vendor/{id} ### Parameters - Role requirement: ROLE_OP_CO_USER ``` -------------------------------- ### Drawer Placement Example Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/docs/design-system/overlay/drawer.md Demonstrates how to control the placement of the Drawer using the `placement` prop. Accepts 'top', 'right', 'bottom', or 'left'. ```jsx function PlacementExample() { const { isOpen, onOpen, onClose } = useDisclosure() const [placement, setPlacement] = React.useState('right') return ( <> Top Right Bottom Left Basic Drawer

Some contents...

Some contents...

Some contents...

) } ``` -------------------------------- ### Install Playwright dependencies Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/tools/forgekit-nx-storybook/README.md Install the necessary packages to enable Playwright component testing and accessibility audits. ```bash npm install --save-dev @playwright/experimental-ct-react @axe-core/playwright --legacy-peer-deps ``` -------------------------------- ### Serve Mkdocs Site Locally Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/docs/readme.md Run this command in the directory containing your mkdocs.yml file to serve the documentation site. Access it via http://localhost:8000. ```bash Mkdocs serve ``` -------------------------------- ### Get Specific Company Vendor Information Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/company-api/application/src/docs/asciidoc/company-vendor.adoc Get information about how a company uses a specific vendor. Requires ROLE_OP_CO_USER. ```bash operation::company-vendor/get[snippets='http-request,response-fields,http-response'] ``` -------------------------------- ### Claude Code Usage Examples Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/tools/storybook-mcp/README.md Example prompts for interacting with the MCP server tools via Claude Code. ```text # List all components without stories Use the list_components tool to show me components in shared-ui that don't have stories # Generate a story for a component Generate a Storybook story for libs/shared/ui/src/lib/card/card.tsx # Analyze a component before generating a story Analyze the component at libs/portal/ui/src/lib/nav/nav.tsx ``` -------------------------------- ### ISO 8601 Date Format Example Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/company-api/doc/architecture/decisions/0012-date-field-format-iso-8601.md Example of a JSON object using the ISO 8601 format for a date field. ```json { "created": "1970-01-01T00:00:00Z" } ``` -------------------------------- ### Basic Icon Usage Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/docs/design-system/media-and-icons/icon.md Examples of importing and styling built-in icons using size and color props. ```jsx import { PhoneIcon, AddIcon, WarningIcon } from '@redesignhealth/ui' // The default icon size is 1em (16px) // Use the `boxSize` prop to change the icon size // Use the `color` prop to change the icon color ``` -------------------------------- ### Run the API Server Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/api-server/README.md Commands to start the mock API server from the repository root or directly via tsx. ```bash # From the repo root npm run start:api # → http://localhost:8080 ``` ```bash npx tsx apps/api-server/src/main.ts ``` -------------------------------- ### Install Nx Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/company-api/README.md Installs Nx, a build system, using npm. The `--legacy-peer-deps` flag is used to handle potential peer dependency conflicts. ```bash $ npm install --legacy-peer-deps ``` -------------------------------- ### Run build and maintenance tasks Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/docs/applications/parser-playground.mdx Common Nx commands for building, linting, and previewing the application. ```bash nx serve parser-playground ``` ```bash nx build parser-playground ``` ```bash nx preview parser-playground ``` ```bash nx lint parser-playground ``` -------------------------------- ### Start Local Development Stack with Rebuild Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/docs/backend/services.mdx Starts the Docker Compose stack and rebuilds any changed images. Use this when you have made modifications to the service code. ```bash docker-compose up --build ``` -------------------------------- ### Useful Nx Commands for Portal Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/portal/README.md Common Nx commands for serving, building, testing, and linting the portal application. ```bash # Serve (dev) nx run portal:serve # Build nx run portal:build # Run unit tests nx run portal:test # Lint nx run portal:lint ``` -------------------------------- ### Grid Item Starting and Ending Lines Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/docs/design-system/layout/grid.md Specify the exact start and end grid lines for a GridItem using `colStart` and `colEnd` props. This allows precise placement within the grid. ```jsx ``` -------------------------------- ### Install theme via symlink Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/tools/code-themes/vscode/redesign-health-theme/README.md Create a symbolic link to the theme directory within the VS Code extensions folder. ```bash $ ln -s /path/to/redesign-health-theme ~/.vscode/extensions/redesign-health-theme ``` -------------------------------- ### Data-Connected Component Example Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/docs/applications/portal/components.mdx Components requiring server data utilize React Query hooks imported from the data-assets library. This example shows fetching company data and displaying a loader if data is still loading. ```tsx import { useCompanies } from '@redesignhealth/portal/data-assets' export function CompanyList() { const { data, isLoading } = useCompanies() if (isLoading) return return } ``` -------------------------------- ### GET /opcos Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/docs/api-reference/opco-service-api/resource/opco.md Retrieve a paginated list of OpCos. ```APIDOC ## GET /opcos ### Description Retrieve a paginated list of OpCos. ### Method GET ### Endpoint /opcos ``` -------------------------------- ### Running Lint Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/libs/company-api-types/README.md Execute linting for the library using the Nx CLI. ```bash nx lint company-api-types ``` -------------------------------- ### GET /form-definition Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/company-api/application/src/docs/asciidoc/form-definition.adoc Retrieves a form schema definition. ```APIDOC ## GET /form-definition ### Description Request a form schema. ### Method GET ### Endpoint /form-definition ``` -------------------------------- ### Build Storybook Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/CLAUDE.md Builds Storybook for deployment. Use 'npm run build-storybook-portal-ui' for the portal UI. ```bash npm run build-storybook # Build Storybook for deployment npm run build-storybook-portal-ui ``` -------------------------------- ### GET /companies Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/company-api/application/src/docs/asciidoc/company.adoc Retrieve a paginated list of companies. ```APIDOC ## GET /companies ### Description Retrieve a paginated list of companies. ### Method GET ### Endpoint /companies ``` -------------------------------- ### GET /vendor/search Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/company-api/application/src/docs/asciidoc/vendor.adoc Searches for vendor information. Requires ROLE_OP_CO_USER. ```APIDOC ## GET /vendor/search ### Description Search vendor information. Requires ROLE_OP_CO_USER. ### Method GET ### Endpoint /vendor/search ``` -------------------------------- ### View Local Documentation Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/docs/readme.md Access the locally served documentation by navigating to this URL in your web browser. ```bash http://localhost:8000 ``` -------------------------------- ### GET /companies/{id} Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/company-api/application/src/docs/asciidoc/company.adoc Retrieve a single company by its ID. ```APIDOC ## GET /companies/{id} ### Description Retrieve a single company. ### Method GET ### Endpoint /companies/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the company. ``` -------------------------------- ### Running Portal UI Tests Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/libs/portal/ui/README.md Execute the test suite for the portal-ui package using Nx. ```bash nx test portal-ui ``` -------------------------------- ### Portal Initialization Sequence Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/docs/architecture.mdx Sequence diagram detailing the steps involved in initializing the portal application, including authentication and data fetching. ```mermaid sequenceDiagram participant Browser participant App participant Auth participant API participant Router Browser->>App: Load application App->>Auth: Initialize auth provider Auth-->>App: Auth state ready App->>API: Fetch user profile API-->>App: User data App->>Router: Initialize routes Router-->>Browser: Render authenticated shell ``` -------------------------------- ### GET /infrastructure-request Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/company-api/application/src/docs/asciidoc/infrastructure-request.adoc Retrieve information about an existing infrastructure request. ```APIDOC ## GET /infrastructure-request ### Description Retrieve information about an infrastructure request. Requires ROLE_OP_CO_USER. ### Method GET ### Endpoint /infrastructure-request ``` -------------------------------- ### GET /role Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/docs/backend/authentication.mdx Retrieves a list of all available roles defined in the system. ```APIDOC ## GET /role ### Description Returns all available roles defined in the system. ### Method GET ### Endpoint /role ``` -------------------------------- ### Manage MCP server for Storybook Source: https://github.com/effinrich/rh-nx-monorepo/blob/main/apps/docs/tooling/development-tools.mdx Commands for setting up and running the Model Context Protocol server for Storybook component generation. ```bash npm run mcp:setup # First-time install + build npm run mcp:storybook:dev # Development mode ```