zana

Zana is a browser extension that adds book information and ratings to supported bookstore websites. The data is retrieved from a list of third-party book APIs.

Installation

You can install the extension from the following stores:

• Firefox
• Chrome and Edge

The extension is not yet on Microsoft Edge Add-ons store, but you can install it on Edge from the Chrome Web Store.

Third-party APIs

Zana has the following clients for third-party APIs:

• Client for Google Books API
• Client for Open Library API

Supported bookstores

• Dukagjini Bookstore

Questions and discussions

For any questions or discussions, please check the Questions and Discussions guide.

Contributing

If you're interested in contributing to the project, please check the CONTRIBUTING.md file.

To add support for a new bookstore please check the Adding Support For a New Bookstore guide.

Local setup, development and building

For setting up, building, and testing Zana locally, please check the Local Setup and Development guide.

Reporting issues or requesting enhancements

To report a bug issue, please check the Reporting a Bug guide.

To suggest an enhancement, please check the Suggesting Enhancements guide.

Project details

Zana is built as a monorepo, and it uses different tools for API clients, the browser extension, deployment, and release handling. Modules are organized as follows:

• services - Rust crates that contain the API clients and the AWS Lambda function binary that serves the data retrieved by the clients.
• extension - Browser extension that is built using WebExtensions API.
• deployment - AWS CDK project that contains the infrastructure.
• tools - Scripts and binaries that help with:
  • Extension local development and packaging for certain platforms.
  • Release management.

Zana is built primarily for Firefox, but it uses browser polyfills to support Chrome and Edge. The Firefox extension is built with Manifest v2, and the Chrome extension with Manifest v3. The whole extension package will be migrated and adapted to Manifest v3 in the near future.

Support for Firefox on Android is not yet available, but it is planned to be added in the future.

Infrastructure

Zana is deployed on AWS, and it is built around its serverless services.

Deployment and releases

Each PR that is merged into the main branch triggers the deployment pipeline, and with each deployment a new release is created (This process may change in the future). Except the extension which is built and published manually, all other modules are built and deployed automatically.