{"id":31934782,"url":"https://github.com/launchrctl/web","last_synced_at":"2025-10-14T06:53:50.588Z","repository":{"id":226186597,"uuid":"756095104","full_name":"launchrctl/web","owner":"launchrctl","description":"Web is a launchr plugin which provides a GUI to visualize and execute actions from the browser","archived":false,"fork":false,"pushed_at":"2025-10-08T15:08:06.000Z","size":1916,"stargazers_count":1,"open_issues_count":17,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-10-08T17:29:21.931Z","etag":null,"topics":["cli","launchr","launchrctl","plugin","ui","webapp"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/launchrctl.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-02-11T23:26:53.000Z","updated_at":"2025-07-07T12:58:49.000Z","dependencies_parsed_at":"2024-04-23T12:42:28.765Z","dependency_job_id":"33a41abb-f007-4cfb-aeac-70696166905e","html_url":"https://github.com/launchrctl/web","commit_stats":null,"previous_names":["launchrctl/web"],"tags_count":27,"template":false,"template_full_name":null,"purl":"pkg:github/launchrctl/web","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/launchrctl%2Fweb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/launchrctl%2Fweb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/launchrctl%2Fweb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/launchrctl%2Fweb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/launchrctl","download_url":"https://codeload.github.com/launchrctl/web/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/launchrctl%2Fweb/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279018138,"owners_count":26086285,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-14T02:00:06.444Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","launchr","launchrctl","plugin","ui","webapp"],"created_at":"2025-10-14T06:53:49.101Z","updated_at":"2025-10-14T06:53:50.571Z","avatar_url":"https://github.com/launchrctl.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Launchr Web plugin\n\nLaunchr Web plugin is an extenstion to [Launchr](https://github.com/launchrctl/launchr) to run actions via Web UI.\nThe plugin consists of a Backend API and a Frontend client.\n\n## Table of contents\n\n* [Usage](#usage)\n* [Development](#development)\n* [Web UI Customization](#web-ui-customization)\n\n## Usage\n\nBuild `launchr` from source locally. Build dependencies:\n1. `go \u003e=1.21`, see [installation guide](https://go.dev/doc/install)\n2. `nodejs 20`, see [NVM](https://github.com/nvm-sh/nvm) or [Volta](https://github.com/volta-cli/volta)\n3. `make`\n\nBuild the `launchr` tool:\n```shell\nmake\nbin/launchr web --help\n```\n\nThe documentation for `launchr` usage can be found in [the main project](https://github.com/launchrctl/launchr).\n\n@todo update readme\n## To build the client:\n### Node\n```shell\ncd client\n# Install yarn 4 https://yarnpkg.com/getting-started/install yarn set version stable\n\n# Fetch dependencies\nyarn\n# Build the project\nyarn build\n# Start client dev server\nyarn dev\n```\n### Docker\n```shell\nmake front-install front-build\n```\n\nSee [client readme](client/README.MD) for more information.\n\nTo run Launchr Web server:\n```shell\n# Run web server on http://localhost:8080\nbin/launchr web\n# To use example as base dir for actions discovery.\nLAUNCHR_ACTIONS_PATH=example bin/launchr web\n# Run web server on http://localhost:3000\nbin/launchr web -p 3000\n# Serve swagger-ui and swagger.json\n# Paths /api/swagger.json and /api/swagger-ui\nbin/launchr web --swagger-ui\n# To proxy requests to client dev server\nbin/launchr web --swagger-ui --proxy-client=http://localhost:5173/\n```\n\nBy default, Launchr HTTP server provides client files from `client/dist`.\nBut as shown above, launchr may be a reverse proxy server for `yarn dev` with `--proxy-client` flag.\n\nIf you face any issues with `launchr`:\n1. Open an issue in the repo.\n2. Share the app version with `launchr --version`\n\n## Development\n\nThe `launchr`  can be built with a `make` to `bin` directory:\n```shell\nmake\n```\nIt is also supported to make a build to use with `dlv` for debug:\n```shell\nmake DEBUG=1\n```\n\nUseful make commands:\n1. Fetch dependencies - `make deps`\n2. Test the code - `make test`\n3. Lint the code - `make lint`\n\n@todo review\n## Test for release\n\n```shell\nmake front-install front-build\nmake EMBED=1\n```\n\n## To push new client release.\n\n```shell\ngit tag v0.0.X\ngit push --tags\n```\nand wait for github action will finished.\n\n## Web UI Customization\n\nLaunchr provides several options to customize the web user interface according to your needs.\n\nYou can customize the web UI by adding a `web` section to your `.binary/config.yaml` file with the following options:\n\n```yaml\nweb:\n  # Exclude specific actions from appearing in the web interface\n  excluded_actions:\n    - web\n    - other-action-to-hide\n\n  # List of variable names that should be exposed to the UI\n  variables:\n    root_name: value\n    tab_title: value\n    header_title: value\n    favicon: value\n    logo: value\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flaunchrctl%2Fweb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flaunchrctl%2Fweb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flaunchrctl%2Fweb/lists"}