{"id":15910505,"url":"https://github.com/politie/ngmodule-viz","last_synced_at":"2025-03-22T08:30:45.129Z","repository":{"id":57325627,"uuid":"83689152","full_name":"politie/ngmodule-viz","owner":"politie","description":"Visualize the dependencies between the NgModules in your Angular 2+ application","archived":false,"fork":false,"pushed_at":"2017-05-16T07:34:15.000Z","size":2057,"stargazers_count":40,"open_issues_count":0,"forks_count":4,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-03-18T09:46:11.258Z","etag":null,"topics":["angular","angular2","angular4","dependency-graph","graph","ngmodule","typescript","visualization"],"latest_commit_sha":null,"homepage":null,"language":"HTML","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/politie.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}},"created_at":"2017-03-02T14:50:20.000Z","updated_at":"2025-02-22T14:40:36.000Z","dependencies_parsed_at":"2022-09-18T23:01:50.349Z","dependency_job_id":null,"html_url":"https://github.com/politie/ngmodule-viz","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/politie%2Fngmodule-viz","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/politie%2Fngmodule-viz/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/politie%2Fngmodule-viz/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/politie%2Fngmodule-viz/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/politie","download_url":"https://codeload.github.com/politie/ngmodule-viz/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244931338,"owners_count":20534005,"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":["angular","angular2","angular4","dependency-graph","graph","ngmodule","typescript","visualization"],"created_at":"2024-10-06T15:07:15.884Z","updated_at":"2025-03-22T08:30:44.575Z","avatar_url":"https://github.com/politie.png","language":"HTML","funding_links":[],"categories":["Awesome Angular [![Awesome TipeIO](https://img.shields.io/badge/Awesome%20Angular-@TipeIO-6C6AE7.svg)](https://github.com/gdi2290/awesome-angular) [![Awesome devarchy.com](https://img.shields.io/badge/Awesome%20Angular-@devarchy.com-86BDC1.svg)](https://github.com/brillout/awesome-angular-components)"],"sub_categories":["Angular \u003ca id=\"angular\"\u003e\u003c/a\u003e"],"readme":"# NgModules visualization \n[![npm version](https://badge.fury.io/js/ngmodule-viz.svg)](https://badge.fury.io/js/ngmodule-viz)\n\nCommandline tool to visualize the dependencies between the @NgModules in your Angular 2+ application.\n\n## Usage\n* Install the tool: `npm install ngmodule-viz -g`.\n\n### Generate dependency information\n* Run `ngmodule-viz \u003cinput\u003e \u003coutput\u003e`, where:\n  * `\u003cinput\u003e` points to your Angular 2+ app (e.g. /Users/johndoe/ui-dashboard) \n  * `\u003coutput\u003e` to the dir where the visualization should be placed (e.g. your current working dir)\n* The tool outputs a _ngmodules.json_ file with all the dependencies between your NgModules. It also outputs an _index.html_ for visualising these dependencies. \n\n### Visualize dependency information\n* Start a http-server (`npm install -g http-server` followed by `http-server`) in your `\u003coutput\u003e` dir.\n* Open http://localhost:8080/\n* Enjoy the graph of your NgModules!\n\n## Example\nLet's visualize the NgModules in this [angular2-realworld-example-app](https://github.com/gothinkster/angular2-realworld-example-app).\n\n* `git clone https://github.com/gothinkster/angular2-realworld-example-app`\n* `ngmodule-viz angular2-realworld-example-app/ .`\n* `http-server`\n* open http://localhost:8080/ and you'll see this:\n\n![ngmodule-viz demo](https://github.com/politie/ngmodule-viz/blob/master/demo/ngmodule-viz-demo.gif \"ngmodule-viz demo\")\n\n## Jenkins integration\n* Run ngmodule-viz in your Jenkins pipeline\n* Use the HTML publisher plugin to publish the resulting html file\n* To avoid CORS issues disable Jenkins CSP using the Jenkins CLI: `System.setProperty(\"hudson.model.DirectoryBrowserSupport.CSP\", \"\")`. WARNING: the latter assumes you have otherwise secured your Jenkins instance. Don't execute this on public instances.\n\n## Building\n* Clone this project\n* Install typescript: `npm install -g typescript`\n* Run `npm run build` to compile the typescript to javascript. Or `npm run build:watch` to keep the typescript compiler running during development.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpolitie%2Fngmodule-viz","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpolitie%2Fngmodule-viz","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpolitie%2Fngmodule-viz/lists"}