https://github.com/joalisonpereira/express-route-list

List routes for Express framework
https://github.com/joalisonpereira/express-route-list

express logger-middleware nodejs

Last synced: 1 day ago
JSON representation

List routes for Express framework

• Host: GitHub
• URL: https://github.com/joalisonpereira/express-route-list
• Owner: joalisonpereira
• License: mit
• Created: 2023-02-08T17:29:53.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-05-08T12:23:18.000Z (10 months ago)
• Last Synced: 2025-02-04T12:22:57.706Z (17 days ago)
• Topics: express, logger-middleware, nodejs
• Language: TypeScript
• Homepage: https://github.com/joalisonpereira/express-route-list#readme
• Size: 388 KB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Express Route List

> List routes for Express Framework

![](./docs/badge-statements.svg) ![](./docs/badge-functions.svg) ![](./docs/badge-lines.svg) ![](./docs/badge-branches.svg)

## Install

```bash

npm i -D express-route-list

```

## Setup

If you are using Typescript in project, read [typescript setup](./docs/TSCONFIGURATION.md)

Export the app (regardless of where you are declaring it).

```js

//app.js

module.exports = app;

```

Create a configuration file:

```js

//route-list.js

const { configure } = require('express-route-list');

const app = require('./app');

configure(app, { showIndex: true, prefix: '' });

```

## Execute

Create a script entry in package.json and run.

```bash

npm pkg set scripts.route-list="node route-list.js"

```

```bash

npm run route-list

```

## Output Example

![](./docs/output.png)

## Why use this package?

This package provides a quick way to easily visualize your application's routes, with a minimal configuration.