Routerix

Routerix is a UI for your routes. Its simple for developers and accessible to other teams. No code is required.

Getting Started

Routerix is a CLI. Its necessary to install it and with 1 command its possible to automatically generate a UI for your routes. Check the Supported frameworks section for current support.

1. Install

pnpm install routerix

2. Configuration

Generate the config file routerix.config.js. This is an Optional step if using CLI args. It's not possible to split config between config file and CLI args. Choose one approach.

pnpm routerix init

Arguments

rootPath	Routes root folder
provider	Project framework key (Supported frameworks)

3. Generate the UI

With config file

pnpm routerix generate

Without config file (example)

pnpm routerix generate --rootPath ./src/app --provider nextjs-app 

3. Access your routes UI

Now you have a folder called .routerix in your project. This is the static UI for your routes.

You can visualize it locally with a local server. Deploy it to a bucket in your CI. Its your decision.

Supported frameworks

Framework	CLI Argument
Next.js App	nextjs-app

Next steps

• Add more providers
• Improve current features
• Get feedback :)