https://github.com/fdesjardins/express-routes-visualizer
Visualize express routes as a graph using D3.js
https://github.com/fdesjardins/express-routes-visualizer
express graph middleware node routes routing viewer visualizer
Last synced: about 1 month ago
JSON representation
Visualize express routes as a graph using D3.js
- Host: GitHub
- URL: https://github.com/fdesjardins/express-routes-visualizer
- Owner: fdesjardins
- License: mit
- Created: 2018-08-21T10:09:22.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-06-27T16:37:28.000Z (11 months ago)
- Last Synced: 2025-03-06T20:46:20.639Z (2 months ago)
- Topics: express, graph, middleware, node, routes, routing, viewer, visualizer
- Language: JavaScript
- Homepage:
- Size: 1.36 MB
- Stars: 5
- Watchers: 2
- Forks: 5
- Open Issues: 6
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# express-routes-visualizer
An express middleware and endpoint for viewing your app's route hierarchy.
[![NPM Version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Coverage][coveralls-image]][coveralls-url]
[![Maintainability][code-climate-image]][code-climate-url]
![Hackathon Starter Example][main-image]
~~Note, this isn't working with `express.Router()` instances at the moment.~~
## Installation
```sh
npm install --save express-routes-visualizer
```
## Usage
```js
const { middleware, visualizer } = require('express-routes-visualizer')
app.use(
'/routes',
middleware({ httpMethods: false }),
visualizer({ theme: 'dark-blue' })
)
```
### Themes
See [./themes.md](./themes.md) for visuals of each scheme.
- `plain` - a plain scheme with a light background
- `light-gray` - a simple light grayscale theme
- `dark-gray` - a simple dark grayscale theme
- `dark-blue` - a darker blue theme loosely based on the Atom Nord theme
- `burn` - a low-contrast scheme inspired by Zenburn
## License
MIT © [Forrest Desjardins](https://github.com/fdesjardins)
[main-image]: .github/main.png
[travis-url]: https://travis-ci.org/fdesjardins/express-routes-visualizer
[travis-image]: https://img.shields.io/travis/fdesjardins/express-routes-visualizer.svg?style=flat
[npm-url]: https://www.npmjs.com/package/express-routes-visualizer
[npm-image]: https://img.shields.io/npm/v/express-routes-visualizer.svg?style=flat
[coveralls-url]: https://coveralls.io/r/fdesjardins/express-routes-visualizer
[coveralls-image]: https://img.shields.io/coveralls/fdesjardins/express-routes-visualizer.svg?style=flat
[code-climate-url]: https://codeclimate.com/github/fdesjardins/express-routes-visualizer/maintainability
[code-climate-image]: https://api.codeclimate.com/v1/badges/629b4edb2f3333f35b43/maintainability