https://github.com/Redocly/developer-portal-starter

Starter template for the Redocly developer portal
https://github.com/Redocly/developer-portal-starter

Last synced: about 2 months ago
JSON representation

Starter template for the Redocly developer portal

• Host: GitHub
• URL: https://github.com/Redocly/developer-portal-starter
• Owner: Redocly
• License: other
• Archived: true
• Created: 2020-04-23T08:43:09.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-08-17T08:01:51.000Z (over 1 year ago)
• Last Synced: 2024-10-30T00:45:41.729Z (2 months ago)
• Language: TypeScript
• Homepage: https://redoc.ly
• Size: 43.6 MB
• Stars: 64
• Watchers: 20
• Forks: 101
• Open Issues: 37
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Redocly API developer portal

> **Warning**

> This version of the beta portal is closed to new registrations. Existing

> customers can continue to use the product, but new projects should not adopt

> this stack. The best way to find out about our next generation of products is

> to [sign up to our product newsletter](https://redocly.com/product-updates/).

## Prerequisites

- [node.js >= 12.22.6 and <= 16.x](https://nodejs.org/en/)

- [yarn](https://yarnpkg.com/en/)

## Install

    yarn install

## Start development server

    yarn start

Note: search isn't functional in the development environment.

## Troubleshooting

We heavily rely on caching for performance issues so if some changes are not reflected in the resulting portal try cleaning cache by running:

    yarn clean

## Docs

Read the [online documentation](https://redoc.ly/docs/developer-portal/introduction/).

## Training program

The starter template contains training exercises which will teach you how to build a developer portal.

After you start the development server, navigate to the app and follow the instructions to get started with your training.