redocly/developer-portal repository overview

⁠Prerequisites

If your portal depends on some external packages like react-modal, react-select they have to be installed as we don’t ship it in our docker image.

yarn install

To significantly speed up a process move @redocly/developer-portal dependency from dependencies to optionalDependencies:

"dependencies": {
  "react-modal": "^3.11.2",
  "react-select": "^3.0.8",
  "timeago.js": "^4.0.2"
},
"optionalDependencies": {
  "@redocly/developer-portal": "1.0.0-beta.76"
}

and run 

yarn install --ignore-optional

⁠Run portal development server

docker run -v $(pwd):/site -it -p 3000:3000 redocly/developer-portal:latest develop

⁠Run the portal build (note that you have to provide a license key)

docker run -v $(pwd):/site -it --env REDOCLY_LICENSE_KEY=<license_key> redocly/developer-portal:latest build

This docker container is still experimental so there may be some issues. We would appreciate it if you report any.

Also, note that performance will be worse than native-run especially on macOS (see details here: https://docs.docker.com/docker-for-mac/osxfs/#performance-issues-solutions-and-roadmap⁠)