{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/developer-portal/getting-started/","matchPath":"","result":{"data":{"markdownRemark":{"html":"

Getting started with Redocly Portal

\n

This page lists steps to install and run the Portal.

\n
\n

Before you begin

\n

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

\n\n\n

Install the Portal

\n
    \n
  1. \nClone the GitHub repository shared by Redocly.\n
    2. \n
\n
\n
`, `88734746848906630000`)\"\n >\n
Copy
\n
Copied
\n
\n 
git clone <url provided by Redocly>
\n
\n
    \n
  1. \nInstall the project.\n
    2. \n
\n
\n
\n
Copy
\n
Copied
\n
\n 
yarn install
\n
\n
Note:

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

\n\n
\n
\n Remove yarn.lockyarn install\n
\n
\n
\n
\n
Copy
\n
Copied
\n
\n 
rm yarn.lock
\n
\n
\n
Copy
\n
Copied
\n
\n 
yarn install
\n
\n
\n \n

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

\n

Run the Portal

\n
\n
\n
Copy
\n
Copied
\n
\n 
yarn start
\n
\n

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

","headings":[{"value":"Getting started with Redocly Portal","depth":1},{"value":"Before you begin","depth":3},{"value":"Install the Portal","depth":3},{"value":"Run the Portal","depth":3}]},"contentItem":{"data":{"lastModified":"2023-03-21T02:46:22.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":false,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"2f956ee0-80a5-5e96-9c6d-fcc53d566848__redocly content/developer-portal/getting-started/","seo":{"title":"Getting started","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"developer-portal/getting-started.md","pageBaseUrl":"/developer-portal/getting-started","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Getting started with Redocly Portal","id":"getting-started-with-redocly-portal"},{"depth":3,"value":"Before you begin","id":"before-you-begin"},{"depth":3,"value":"Install the Portal","id":"install-the-portal"},{"depth":3,"value":"Run the Portal","id":"run-the-portal"}]},"data":{"title":"Getting started"},"catalogInfo":null,"link":"/developer-portal/getting-started/","sidebarName":"","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":null,"apiVersionId":null,"isDefaultApiVersion":null}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}