README.md

Swagger UI

A Swagger UI implementation that can deployed as a static site and parses a remote Swagger JSON.

Table of contents

• 1. Overview
• 2. Development
  • 2.1. Requirements
  • 2.2. Setup
  • 2.3. Running locally
• 3. Appendix
  • 3.1. Useful Commands
• 4. How To Contribute
• 5. License

🔭 1. Overview

This is a simple frontend build wraps around Swagger UI using React.

It takes a SWAGGER_SPEC_URL environment variable that should point to a valid Swagger JSON.

🛠 2. Development

2.1. Requirements

• Install Node v18.20.3+
• Install Yarn v1.22.5+

^{Back to top ^}

2.2. Setup

1. Install the dependencies:

$ yarn install

^{Back to top ^}

2.3. Running locally

1. Run:

$ yarn start

2. Open a browser and go to http://localhost:8080.

^{Back to top ^}

📑 3. Appendix

3.1. Useful Commands

Command	Description
yarn build	Builds the source code into the dist/ directory.
yarn clean	Deletes the dist/ directory.
yarn env	Copies the .env.example to a .env file.
yarn lint	Runs the linter on .js(x) and .ts(x) files.
yarn prettier	Runs the prettier on .js(x) and .ts(x) files.
yarn start	Builds and serves a development version at http://localhost:8080.
yarn typecheck	Runs a quick type-check on the .ts(x) files in the source.

^{Back to top ^}

👏 4. How To Contribute

Please read the Contributing Guide to learn about the development process.

^{Back to top ^}

📄 5. License

Please refer to the LICENSE file.

^{Back to top ^}