Redocly API developer portal

Warning This version of the beta portal is closed to new registrations. Existing customers can continue to use the product, but new projects should not adopt this stack. The best way to find out about our next generation of products is to sign up to our product newsletter.

Prerequisites

• node.js >= 12.22.6 and <= 16.x
• yarn

Install

yarn install

Start development server

yarn start

Note: search isn't functional in the development environment.

Troubleshooting

We heavily rely on caching for performance issues so if some changes are not reflected in the resulting portal try cleaning cache by running:

yarn clean

Docs

Read the online documentation.

Training program

The starter template contains training exercises which will teach you how to build a developer portal. After you start the development server, navigate to the app and follow the instructions to get started with your training.