Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/readmeio/api-explorer
Open source components that make up ReadMe's legacy API explorer
https://github.com/readmeio/api-explorer
openapi react
Last synced: about 2 months ago
JSON representation
Open source components that make up ReadMe's legacy API explorer
- Host: GitHub
- URL: https://github.com/readmeio/api-explorer
- Owner: readmeio
- License: mit
- Archived: true
- Created: 2017-07-19T17:25:56.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2021-12-10T15:09:15.000Z (almost 3 years ago)
- Last Synced: 2024-07-31T10:59:26.790Z (about 2 months ago)
- Topics: openapi, react
- Language: JavaScript
- Homepage:
- Size: 61.8 MB
- Stars: 85
- Watchers: 21
- Forks: 23
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
> 🚨 With the release of ReadMe's reference guide redesign this repository and codebase has been deprecated.
>
> If you have issues with this legacy API Explorer or our current Reference guides, please email our support team at [email protected]
# api-explorer
Open source components that make up ReadMe's API Explorer.
[](https://github.com/readmeio/api-explorer)
[](https://readme.io)
This repo consists of the following npm modules:
- [@readme/api-explorer](https://npm.im/@readme/api-explorer) — React components that make up the API Explorer
- [@readme/api-logs](https://npm.im/@readme/api-logs) — React components for ReadMe Metrics
## Installation
```sh
git clone [email protected]:readmeio/api-explorer.git
cd api-explorer
npm ci
```
## Running the tests
```sh
npm test
```
## Usage
To spin up an example server:
```sh
npm start
```
## Fetching the latest stylesheet from ReadMe
```
# Fetch the latest
curl https://docs.readme.com/css/bundle-hub2.css -o example/bundle-hub2.css
```