A user is able to build OpenAPI Specification document adheres to established best practices and standards.
This repository contains the frontend service built with React (Built by Vite), Typescript, and Redux.
The primary purpose of this frontend service is to provide a user-friendly interface for maintaining API specification that adhere to OpenAPI Specification (OAS) 2.0 and 3.0 standards.
To get started, clone the repository and install the dependencies:
git clone https://github.com/congmul/oas-editor.git
cd oas-editor
npm install
To run the development server:
npm run dev
this will start the apllication on 'http://localhost:3000'. (PORT can be changed in vite.confg.ts)
oas-editor/
├── .github/ # github action
├── src/
│ ├── assets/
│ ├── components/
│ ├── sass/
│ ├── utils/
│ ├── App.tsx
│ └── main.tsx # Entry point
├── package.json
├── tsconfig.json
└── vite.config.ts
There are several ways you can contribute to the project: