What Chek is
Chek is a reader for books and comics. It has five parts. You need only the parts that match what you want to do.
| Part | What it does | Repository |
|---|---|---|
| Chek app | Reads books and comics on iPhone and iPad. It opens files on the device with no account, and it connects to Chek servers. It’s free on the App Store. | readchek/app |
| Chek web app | Changes account and content settings at app.chek.page. It calls your server from the browser. | readchek/app |
| Chek server | Serves a library that you host yourself. It scans folders, reads Komga and Kavita servers, runs source extensions, syncs reading positions, and serves an OPDS 2 catalog. It’s written in Rust. | readchek/chek |
| Extensions | Add sources that the server reads series from. Each extension is a WebAssembly component that the server installs from an extension repository. | readchek/extensions |
| Chek Reader | Opens, lays out, and pages publications in the app. It’s a Swift package with no Chek-specific code, so any Apple app can use it. | readchek/chek-reader |
The server is optional
Section titled “The server is optional”The app reads files on the device without a server. A server adds three things. Your library is the same on every device. Reading positions, bookmarks, and highlights sync between devices. And the app can read from Komga, Kavita, and extensions through the server.
Pick your path
Section titled “Pick your path”- To run your own library server, start with the quick start. Then install the server behind HTTPS.
- To build a client, a script, or an integration, read the API overview and the API reference.
- To browse Chek from an OPDS reader, read Browse Chek from an OPDS reader.
- To write a source, read the extension README. It covers the
chek extcommand. - To add a reader to your own Swift app, read the Chek Reader README.