e904b667c6
Build/Publish Develop Docs / deploy (push) Failing after 1s
PaddleOCR Code Style Check / check-code-style (push) Failing after 1s
PaddleOCR PR Tests GPU / detect-changes (push) Failing after 1s
PaddleOCR PR Tests / detect-changes (push) Failing after 1s
PaddleOCR PR Tests GPU / test-pr-gpu (push) Has been cancelled
PaddleOCR PR Tests / test-pr (push) Has been cancelled
PaddleOCR PR Tests GPU / test-pr-gpu-impl (push) Has been cancelled
PaddleOCR PR Tests / test-pr-python (3.13) (push) Has been cancelled
PaddleOCR PR Tests / test-pr-python (3.8) (push) Has been cancelled
PaddleOCR PR Tests / test-pr-python (3.9) (push) Has been cancelled
50 lines
1.2 KiB
Markdown
50 lines
1.2 KiB
Markdown
# PaddleOCR.js
|
|
|
|
English | [简体中文](README_cn.md)
|
|
|
|
Official browser OCR SDK and demo for PaddleOCR.
|
|
|
|
## Project structure
|
|
|
|
| Path | Role |
|
|
| ---------------- | ---------------------------------------------------------------------- |
|
|
| `packages/core/` | Browser SDK sources; published to npm as **`@paddleocr/paddleocr-js`** |
|
|
| `apps/demo/` | Vite demo app that depends on the SDK |
|
|
|
|
## Local development and demo
|
|
|
|
```bash
|
|
npm install
|
|
npm run dev:demo
|
|
```
|
|
|
|
Other common commands:
|
|
|
|
```bash
|
|
npm run build
|
|
npm run test
|
|
npm run typecheck
|
|
npm run check
|
|
```
|
|
|
|
Workspace-scoped examples:
|
|
|
|
```bash
|
|
npm run build --workspace packages/core
|
|
npm run build --workspace apps/demo
|
|
```
|
|
|
|
## Documentation
|
|
|
|
| Topic | Link |
|
|
|-------|------|
|
|
| Architecture | [architecture.md](docs/architecture.md) |
|
|
| Development | [development.md](docs/development.md) |
|
|
| Monorepo conventions | [monorepo.md](docs/monorepo.md) |
|
|
| SDK package README | [packages/core/README.md](packages/core/README.md) |
|
|
|
|
## Acknowledgements
|
|
|
|
- [ONNX Runtime Web](https://onnxruntime.ai/) for browser-side ONNX inference
|
|
- [OpenCV.js](https://opencv.org/) for browser-side image processing
|