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

Install the developer portal

\n

Clone

\n
\n
\n
Copy
\n
Copied
\n
\n 
git clone git@github.com:Redocly/developer-portal-starter.git\n\ncd developer-portal-starter
\n
\n

Install dependencies

\n

Before you start... you'll need node and yarn installed.

\n\n
\n
\n
Copy
\n
Copied
\n
\n 
yarn install
\n
\n
attention

Depending on your operating system, you may see warnings when installing dependencies.

\n

Start the development environment

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

This command will start a development server.\nMost functionality exists in the development server except for search.\nWhen the server is ready, the url will be published to the console.\nIt may default to http://localhost:3000.\nOpen that in a browser to see this developer portal load.

\n

Stop the development environment

\n

Press control and c.

\n

\n \n \n

\n

Clearing cache

\n
warning

Troubleshooting? Try this out.

\n

A few changes (such as changing the key of a sidebar definition) require clearing cache to reflect in the local server.\nWe actively reduce these to make the best development environment experience possible.

\n
    \n
  1. \nPress control-c.\n
    2. \n
  2. \nRun \nyarn clean\n in the command prompt to clear the cache.\n
    3. \n
  3. \nRun \nyarn start\n again.\n
    4. \n
\n

Next steps

\n

You are ready to train!

\n

Go to the training exercises list.

","headings":[{"value":"Install the developer portal","depth":1},{"value":"Clone","depth":2},{"value":"Install dependencies","depth":2},{"value":"Start the development environment","depth":2},{"value":"Stop the development environment","depth":2},{"value":"Clearing cache","depth":2},{"value":"Next steps","depth":2}]},"contentItem":{"data":{"lastModified":"2025-12-17T21:55:39.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":true,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"30778a65-bfc4-5322-9a80-d2b7374d4dbe__redocly content/developer-portal/setup/","seo":{"title":"Install the developer portal","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null},"pageId":"developer-portal/setup.md","pageBaseUrl":"/developer-portal/setup","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Install the developer portal","id":"install-the-developer-portal"},{"depth":2,"value":"Clone","id":"clone"},{"depth":2,"value":"Install dependencies","id":"install-dependencies"},{"depth":2,"value":"Start the development environment","id":"start-the-development-environment"},{"depth":2,"value":"Stop the development environment","id":"stop-the-development-environment"},{"depth":2,"value":"Clearing cache","id":"clearing-cache"},{"depth":2,"value":"Next steps","id":"next-steps"}]},"data":{"title":""},"catalogInfo":null,"link":"/developer-portal/setup/","sidebarName":"","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":null,"apiVersionId":null,"isDefaultApiVersion":null}},"staticQueryHashes":["1123603147","1180902673","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3743992808","561138138"]}