Skip to content

baraja-core/structured-api-doc-react

Repository files navigation

React frontend for Structured API Documentation

This package is a React frontend for the Structured API doc library. We use a Next.js project.

Getting Started

First, run the development server:

npm run dev
# or
yarn dev

Open https://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.tsx. The page auto-updates as you edit the file.

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deployment

When a new version of the application is released, you need to perform a build using the yarn build command and copy the contents of the out directory to the original package. The contents of all files are automatically distributed via a proxy PHP script directly in the library.