Last updated 2 years ago

Getting started with Redocly Portal

This page lists steps to install and run the Portal.

Before you begin

Before installing the Redocly Portal, make sure to do the following:

  • Install npm or yarn. These package managers work across all the major operating systems).
  • Know how to run the commands from the CLI (for example, yarn install). For Windows, we recommend using Git Bash.
  • Know the basic git techniques (creating a branch, committing, and in our examples, opening a pull request on GitHub.)
  • Get familiar with Markdown. We recommend using the Visual Studio Code application to manage your files.

Install the Portal

  1. Clone the GitHub repository shared by Redocly.
git clone <url provided by Redocly>
  1. Install the project.
yarn install

NOTE: If an error occurs during the installation, delete the yarn.lock file, and then try to install Redocly Portal again.

rm yarn.lock
yarn install

If the installation problem persists, please contact the Redocly support.

Run the Portal

yarn start

You can now preview your files on the local server. The corresponding address will be displayed in the terminal.