Install Now
How to install Redocly/redoc. Official installation instructions. Project installation guide. Framework or library installation. Build installation instructions. How to setup and install from GitHub. Installation steps and setup instructions. Official docs and installation instructions GitHub.
Redocly/redoc Installation Guide
How to install Redocly/redoc. Official project installation instructions and setup guide.
⚡
Automated Install (Recommended)
Quick installation instructions for Redocly/redoc. This is the fastest way to complete project installation and setup.
Install via curl
curl -fsSL https://hexmos.com/ipm-install | bash &&
ipm i Redocly/redocor
Install via npx
npx @hexmos/ipm i Redocly/redocPrerequisites
Node.js
languageVersion: >= 16.0.0
npm
package_managerVersion: 8.14.3
yarn
package_managerVersion: 20.0.0
Docker
system_toolFor containerizing the application.
Git
knowledgeManual Installation Methods
Manual installation instructions. How to install from GitHub source.
CLI (Command Line Interface)
npx @redocly/cli build-docs openapi.yamlPackage Manager (Node Package Manager)
npx redoc build-docs openapi.yamlPost Installation Steps
- Start the server using `npm start`.
- Run database migrations with `npx sequelize-cli db:migrate`.