Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ericklv/scalar-multiple-apis
https://github.com/ericklv/scalar-multiple-apis
docs openapi redocly scalar stoplight swagger
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/ericklv/scalar-multiple-apis
- Owner: ericklv
- License: agpl-3.0
- Created: 2024-07-06T03:54:03.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-07-12T05:26:37.000Z (4 months ago)
- Last Synced: 2024-10-01T06:43:14.755Z (about 2 months ago)
- Topics: docs, openapi, redocly, scalar, stoplight, swagger
- Language: CSS
- Homepage: https://sad-docs.netlify.app/
- Size: 180 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Scalar Multiple APIs
Simple landing to show all your OpenAPI files powered by Scalar API Reference.
## Customize
In the `src/config` folder you can customize the json files.
- `apis.json` : Add all your OpenAPI/Swagger files.
- `company.json` : Customize with your info.
- `ts-particles/*.json` : Add your own JSON file with config for ts-particles animation or use `default.json`. Check in company.json if ts-particles is enabled.
To load custom animation config edit `src/components/ts_particles.tsx`
```tsx
import { default_ as config } from '../config/ts-particles';
const ParticlesBg = () => {
//...
}
```
## Run locally
1. Install node v18.18.0 or superior.
2. In root directory, run the following commands:
```shell
npm install
npm run dev
```
3. If you want test on local network
```shell
npm run dev -- --host
```
## Packages
### Scalar API Reference
Generate interactive API Docs from OpenAPI/Swagger documents.
- [@scalar/api-reference-react](https://github.com/scalar/scalar)
### TS Particles
A lightweight TypeScript library for creating particles compatible with React, Vue, Angular and others.
- [@tsparticles/react](https://github.com/tsparticles/react) React + TS
- [@tsparticles/engine](https://github.com/tsparticles/tsparticles) No framework
- [Animations presets](https://particles.js.org/samples/presets/index.html) Examples
- [Mateo Bruno Codepen](https://codepen.io/collection/DPOage?cursor=eyJwYWdlIjoxfQ==) Examples with preview
### React + TypeScript + Vite
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
Currently, two official plugins are available:
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh