https://github.com/idea2app/book-reader
An AI OCR & speak tool for people who love the Paper Book & tired to read with their own eyes.
https://github.com/idea2app/book-reader
Last synced: 5 months ago
JSON representation
An AI OCR & speak tool for people who love the Paper Book & tired to read with their own eyes.
- Host: GitHub
- URL: https://github.com/idea2app/book-reader
- Owner: idea2app
- Created: 2024-09-28T13:44:14.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-07T15:47:20.000Z (over 1 year ago)
- Last Synced: 2025-07-06T18:14:20.341Z (12 months ago)
- Language: TypeScript
- Homepage: https://idea-book-reader.pages.dev/
- Size: 1.09 MB
- Stars: 2
- Watchers: 5
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: ReadMe.md
Awesome Lists containing this project
README
# PaperBookReader
App Project scaffold of [WebCell][1] v3
https://pager-book-reader.pages.dev/
[][2]
[][3]
[][4]
## Technology stack
- Language: [TypeScript v5][5]
- Component engine: [WebCell v3][1]
- Component suite: [BootCell v2][7]
- PWA framework: [Workbox v7][8]
- Package bundler: [Parcel v2][9]
- CI / CD: GitHub [Actions][10] + [Pages][11]
## Development
```shell
npm i pnpm -g
pnpm i
npm start
```
## Deployment
```shell
pnpm build
```
## Best practice
1. Install GitHub apps in your organization or account:
1. [Probot settings][12]: set up Issue labels & Pull Request rules
2. [PR badge][13]: set up Online [VS Code][14] editor entries in Pull Request description
2. Click the **[Use this template][15] button** on the top of this GitHub repository's home page, then create your own repository in the app-installed namespace above
3. Click the **[Open in GitHub codespaces][3] button** on the top of ReadMe file, then an **online VS Code development environment** will be started immediately
4. Set [Vercel variables][16] as [Repository secrets][17], then every commit will get an independent **Preview URL**
5. Recommend to add a [Notification step in GitHub actions][18] for your Team IM app
6. Remind the PMs & users of your product to submit **Feature/Enhancement** requests or **Bug** reports with [Issue forms][19] instead of IM messages or Mobile Phone calls
7. Collect all these issues into [Project kanbans][20], then create **Pull requests** & add `closes #issue_number` into its description for automation
[1]: https://web-cell.dev/
[2]: https://github.com/Open-Source-Bazaar/PaperBookReader/actions/workflows/main.yml
[3]: https://codespaces.new/Open-Source-Bazaar/PaperBookReader
[4]: https://gitpod.io/?autostart=true#https://github.com/Open-Source-Bazaar/PaperBookReader
[5]: https://typescriptlang.org/
[7]: https://bootstrap.web-cell.dev/
[8]: https://developers.google.com/web/tools/workbox
[9]: https://parceljs.org/
[10]: https://github.com/features/actions
[11]: https://pages.github.com/
[12]: https://github.com/apps/settings
[13]: https://pullrequestbadge.com/
[14]: https://code.visualstudio.com/
[15]: https://github.com/new?template_name=PaperBookReader&template_owner=EasyWebApp
[16]: https://github.com/Open-Source-Bazaar/PaperBookReader/blob/eaa710bc8d737a52bf726ebe339e2a29db7e3e04/.github/workflows/main.yml#L9-L11
[17]: https://github.com/Open-Source-Bazaar/PaperBookReader/settings/secrets/actions
[18]: https://github.com/kaiyuanshe/kaiyuanshe.github.io/blob/bb4675a56bf1d6b207231313da5ed0af7cf0ebd6/.github/workflows/pull-request.yml#L32-L56
[19]: https://github.com/Open-Source-Bazaar/PaperBookReader/issues/new/choose
[20]: https://github.com/Open-Source-Bazaar/PaperBookReader/projects