https://github.com/classchartsapi/api-docs
Unofficial documentation for the Classcharts API
https://github.com/classchartsapi/api-docs
classcharts docs openapi
Last synced: 4 months ago
JSON representation
Unofficial documentation for the Classcharts API
- Host: GitHub
- URL: https://github.com/classchartsapi/api-docs
- Owner: classchartsapi
- Created: 2024-05-30T21:22:24.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-18T22:41:47.000Z (10 months ago)
- Last Synced: 2025-04-19T09:17:33.445Z (10 months ago)
- Topics: classcharts, docs, openapi
- Language: MDX
- Homepage: https://classchartsapi.github.io/api-docs/
- Size: 456 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ClassCharts API Docs
Unofficial API documentation for ClassCharts.
You can find a hosted version at [classchartsapi.github.io/api-docs](https://classchartsapi.github.io/api-docs/).
## Development Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
| :------------------------- | :----------------------------------------------- |
| `pnpm install` | Installs dependencies |
| `pnpm dev` | Starts local dev server at `localhost:3000` |
| `pnpm build` | Builds the docs site for production |
| `pnpm start` | Starts the built site for production |
| `pnpm generate` | Generates all OpenAPI schema defs into files |
| `pnpm postbuild` | Generates indexs for Algolia |