{"id":24905827,"url":"https://github.com/microsoft/service-fabric-explorer","last_synced_at":"2025-04-04T11:14:32.986Z","repository":{"id":37359415,"uuid":"112569817","full_name":"microsoft/service-fabric-explorer","owner":"microsoft","description":"Service Fabric Explorer is a web based dashboard for visualizing the state of a Service Fabric cluster.","archived":false,"fork":false,"pushed_at":"2025-03-28T20:54:22.000Z","size":18839,"stargazers_count":107,"open_issues_count":109,"forks_count":66,"subscribers_count":58,"default_branch":"master","last_synced_at":"2025-03-30T21:39:07.134Z","etag":null,"topics":["angular8","service-fabric","sfx","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/microsoft.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":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-11-30T05:43:37.000Z","updated_at":"2025-03-28T20:54:26.000Z","dependencies_parsed_at":"2024-04-22T18:27:00.782Z","dependency_job_id":"00c2a783-d146-4bdf-b3e3-18fd9714d624","html_url":"https://github.com/microsoft/service-fabric-explorer","commit_stats":null,"previous_names":["azure/service-fabric-explorer"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fservice-fabric-explorer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fservice-fabric-explorer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fservice-fabric-explorer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fservice-fabric-explorer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/microsoft","download_url":"https://codeload.github.com/microsoft/service-fabric-explorer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247166168,"owners_count":20894654,"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","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":["angular8","service-fabric","sfx","typescript"],"created_at":"2025-02-02T00:25:26.539Z","updated_at":"2025-04-04T11:14:32.978Z","avatar_url":"https://github.com/microsoft.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Service Fabric Explorer (SFX)\nService Fabric Explorer is an application for inspecting and managing cloud applications and nodes in a Microsoft Azure Service Fabric cluster.\n\n## Build Status\nWindows | Linux / macOS\n------------ | -------------\n![Image of Windows Build Badge](https://ci.appveyor.com/api/projects/status/ejfk6b0c3dlunkws/branch/master) | ![Image of Linux/macOS Build Badge](https://travis-ci.org/Microsoft/service-fabric-explorer.svg?branch=master) \n\nFor more information about the application and how to use it: https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-visualizing-your-cluster\n### Preparing the development machine\n\nTo develop Service Fabric Explorer, the following components are required.\n\n* Git: https://git-scm.com/\n* Node.js (use LTS version): https://nodejs.org/\n\nThe recommended IDE for Service Fabric Explorer development is VSCode because VSCode is a cross-platform editor, which supports Windows, Linux and macOS. But you can use whatever editor to develop. \n\nHere's a list of common IDE used.\n* VSCode: https://code.visualstudio.com/ \n* Visual Studio: https://www.visualstudio.com/\n\n### Set up the development environment\n\n1. Clone the master branch.\n`git clone --recurse-submodules https://github.com/Microsoft/service-fabric-explorer.git \u003cpath to the local folder\u003e`\n2. Install project dependencies: *This can be done inside VSCode or use a console window.*\n   1. [SFX] install the following [CLI](https://angular.io/cli) for the angular project \n   ```Shell\n   npm install -g @angular/cli\n   ```\n   1. [SFX] Navigate to `src/SfxWeb` and run the following scripts.\n   ```Shell\n   npm install   \n   ```\n\n   1. [SFX Proxy] Navigate to `src/Sfx-Proxy` and run the following scripts.\n   ```Shell\n   npm install   \n   ```\n\n3. Build projects\n   * VSCode\n      1. Open `src/SfxWeb` and `src/Sfx-Proxy` in VSCode with multiple-root workspce.\n   * Console\n      1. [SFX] Navigate to `src/SfxWeb` and run the following scripts.\n      For a develop/quick build\n      ```Shell\n      npm run build\n      ```\n      For a production build\n      ```\n      npm run build:prod\n      ```\n\n### Develop Locally and Run Local Proxy\nNavigate to `src/SfxWeb`\n```Shell\nnpm start\n```\nNavigate to `src/Sfx-Proxy`\n```Shell\nnpm start\n```\n\n\u003e [!NOTE]  \n\u003e SFX-Proxy is a local dev tool to forward cluster requests for testing purposes. It should not be hosted as a public server.\n\nThere are 2 optional flags\n-r which would record every request to a folder(by default called playbackRecordings) and overwriting if the same request is made again\n-p every request will be checked for a saved response and if one exists get served instead\n```Shell\nnpm start -- r p\n```\n\nIf proxying requests to a secure cluster adding a file called localsettings.json to src/Sfx-Proxy can take a cert pfx location like below.\n```\n{\n  \"TargetCluster\": {\n    \"Url\": \"https://test.eastus.cloudapp.azure.com:19080\",\n    \"PFXLocation\": \"C:/some_cert.pfx\",\n    \"PFXPassPhrase\": \"password\"\n  },\n  \"recordFileBase\": \"playbackRecordings/\"\n}\n```\n\n\n## Testing\n\n### Run unit tests\nNavigate to  `src/SfxWeb` folder and run \n```\nnpm test\n```\n\n### Run E2E tests\nNavigate to src/SfxWeb folder and run\n```\nnpm run cypress:local\n```\nThis assumes that the angular local dev server is running\n\n### Generate test coverage report\n(see the following for reference https://lukas-klement.medium.com/implementing-code-coverage-with-angular-and-cypress-6ed08ed7e617)\n\nRun a full E2E suite above and this will generate a code coverage report.\nNavigate to src/SfxWeb folder and run\n```\nnpm run test:coverage\n```\nThen you can also view a full report at\n```\nsfxWeb/coverage/lcov-report/index.html\n```\n\n### CI overview\nThe CI will run the following\n\n* production build\n* unit tests\n* E2E tests\n\n## Issues and questions\n\nFor questions related to Azure Service Fabric clusters, take a look at the [tag on StackOverflow](https://stackoverflow.com/questions/tagged/azure-service-fabric)\nand [official documentation](https://docs.microsoft.com/en-us/azure/service-fabric/).\n\n### General Service Fabric issues\n\nIf your issue is not specific to the Service Fabric Explorer, please use the [Service Fabric issues repository](https://github.com/Azure/service-fabric-issues/issues) to report an issue.\n\n### Service Fabric Explorer specific issues\n\nIf your issue is relevant to the Service Fabric Explorer, please use this repositories issue tracker.\n\nBe sure to search for similar previously reported issues prior to creating a new one.\nIn addition, here are some good practices to follow when reporting issues:\n\n- Add a `+1` reaction to existing issues that are affecting you\n- Include detailed output or screenshots when reporting unexpected error messages\n- Include the version of SFX installed\n- Include the version of Service Fabric runtime for the cluster you have selected\n\n## New ideas and improvements\n\nWe encourage everyone to contribute to this project, following the contribution guidelines below. If you have ideas and want to share these with the community before taking on implementing the change, feel free to suggest these using issues.\n\n# Contribution guidelines\n\nFor general contribution guidelines, plese see here: https://github.com/Microsoft/service-fabric/blob/master/CONTRIBUTING.md\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrosoft%2Fservice-fabric-explorer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicrosoft%2Fservice-fabric-explorer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrosoft%2Fservice-fabric-explorer/lists"}