Open source components that make up ReadMe's API explorer
Switch branches/tags
anchor-baseUrl api-logs-updates api-logs box-enhancements bug/add-protocol-when-missing bug/add-string-type bug/anchor-scroll bug/array-of-nulls bug/auth-box-refresh bug/better-missing-oas-servers-support bug/callout-markdown bug/content-type-header bug/do-not-send-empty-objects bug/enum-types bug/fix-copy-code bug/fix-hot-reloading bug/fix-manual-oauth-api-key bug/fix-syntax-highlighting bug/invalid-json-response bug/kotlin-php-without-opening-tag bug/multiple-forms-submit bug/numbers-without-format bug/querystrings-in-metadata bug/reference-links bug/rename-group-id bug/snippet-undefined bug/0.9.4-regression bugs/selected-codesample change-flags-stripe-namespacing enhancement/copy-code-button enhancement/example-collapsible-json feature/accept-header feature/add-proxy-for-http-only feature/add-suggest-edits feature/allow-apisetting-id feature/api-logs-error feature/authentication-box-without-auth feature/better-cc-coverage-report feature/capitalize-language-titles feature/change-url feature/circular-references feature/code-sample-response-2 feature/code-sample-response feature/column-layout-responses feature/convert-angular-links feature/convert-jade-to-jsx feature/css-forms feature/custom-array-field feature/custom-code-samples feature/disable-waypoint feature/double-slash feature/experimental feature/export-content-component feature/form-data feature/form-styling-2 feature/form-styling feature/form-with-icons feature/ie11-new feature/ie11-support feature/json-type feature/json-viewer feature/jwt-latest feature/jwt feature/mimeType feature/multiple-oauth-schemes feature/multiple-schemes feature/nested-response-schema feature/oas-preview feature/oauth feature/prettier feature/project-flags feature/react-error-boundary feature/readonly feature/rename-modules feature/response-schema feature/response-url-without-proxy feature/restyling feature/security-input-with-apiKey feature/send-defaults feature/set-cookie feature/ssr feature/stripe-layout feature/stripes feature/support-swagger feature/support-widgets feature/top-level-body-param feature/try-it-now-proxy feature/try-it-now feature/x-headers fix/snippet-loader gh-pages html-block-variables logs/css-tweaks master nadalfederer-149-fix-parameter-bug nadalfederer-feature/response-schema nadalfederer-feature/update-markdown test-lerna-publish try-it-metrics
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
example
legacy-stuff
lib
packages
scripts
.babelrc Get markdown tests passing Aug 2, 2018
.codeclimate.yml
.editorconfig
.eslintignore
.eslintrc Lint Sep 24, 2018
.gitignore
.jsinspectrc
LICENSE
README.md
build.sh
jest.config.js
lerna.json
package-lock.json
package.json
webpack.common.js
webpack.config.js
webpack.prod.js

README.md

api-explorer

Open source components that make up ReadMe's API explorer

CircleCI

This repo consists of the following npm modules:

Installation

git clone git@github.com:readmeio/api-explorer.git
cd api-explorer
npm install
npx lerna bootstrap

Running the tests

npm test

Usage

To spin up an example server:

npm start

To build the packages for production:

npm run build

To deploy the latest example to gh-pages:

npm run deploy

To publish all modules to npm:

npm run publish

Fetching the latest stylesheet from ReadMe (for the demo site)

# Fetch the latest
curl https://readme.readme.io/css/bundle-hub2.css -o example/bundle-hub2.css

# Remove relative paths for gh-pages
sed -i '' 's/\.\.\///g' example/bundle-hub2.css

Credits

Dom Harrington

License

ISC