https://github.com/darosh/oax-upgrade
[TEMPORARY] Upgrading darosh/oax repo to vue-cli-3 etc...
https://github.com/darosh/oax-upgrade
Last synced: 2 months ago
JSON representation
[TEMPORARY] Upgrading darosh/oax repo to vue-cli-3 etc...
- Host: GitHub
- URL: https://github.com/darosh/oax-upgrade
- Owner: darosh
- License: mit
- Created: 2018-12-04T19:36:29.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-12-07T21:36:48.000Z (over 6 years ago)
- Last Synced: 2025-01-25T16:41:59.578Z (4 months ago)
- Language: Vue
- Homepage: https://darosh.github.io/oax-upgrade/
- Size: 32 MB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OAX — OpenAPI Specification Explorer [](https://darosh.github.io/oax/)
## Resources
* Online [demo](https://darosh.github.io/oax/)
* Automated [screenshots](./doc/screenshots/README.md)
* [Research](./doc/RESEARCH.md) notes
## Status
Feature|Status|Note
:---|:---|:---
OpenApi directory browser| 100%| 500+ API specifications powered by [APIs.guru](https://apis.guru/openapi-directory/)
SDK code generator| 100%| powered by [swagger-codegen](https://github.com/swagger-api/swagger-codegen) via [generator.swagger.io](https://generator.swagger.io/)
Markdown & syntax highlight| 100%| using [showdown](https://github.com/showdownjs/showdown) & [highlight.js](https://highlightjs.org/) with 40 language highlighters
Using web worker| 100%| for non-blocked user interface
Light & dark theme| 100%| thanks to [Vuetify](https://vuetifyjs.com/)
Built-in HTTP reference| 100%| by [know-your-http-well](https://github.com/for-GET/know-your-http-well)
Responsive & mobile| 100%|
Offline & progressive| 80%|
Keyboard shortcuts & navigation| 80%|
View & layout options| 80%|
Schema & examples| 75%|
Try out API| 50%|
CORS proxy| 50%|
Edit specification| 50%| using [CodeMirror](http://codemirror.net/) editor and web worker
TODO:
hinting
scroll to operation
markdown
YAML
Search| 10%|
Security definitions| 25%|
Customization & configuration| 10%|
SEO & SSR| 0%|
Local storage for user settings| 0%|
Cross-browser compatibility| 0%| not tested yet (Chrome browser should work)
Print style & PDF export| 0%|
OpenAPI version 3.0| 0%|
## Build Setup
### Install
``` bash
npm install # or yarn (yarn required for NUXT build)
```
### Webpack
``` bash
npm run webpack:dev # serve with hot reload at localhost:8080
npm run webpack:build # build for production with minification
npm run webpack:report # build for production and view the bundle analyzer report
```
## Project setup
```
yarn install
```
### Compiles and hot-reloads for development
```
yarn run serve
```
### Compiles and minifies for production
```
yarn run build
```
### Run your tests
```
yarn run test
```
### Lints and fixes files
```
yarn run lint
```
### Run your end-to-end tests
```
yarn run test:e2e
```
### Run your unit tests
```
yarn run test:unit
```
### Customize configuration
See [Configuration Reference](https://cli.vuejs.org/config/).