Skip to content

adjwilli/booknoter

Repository files navigation

BookNoter

BookNoter is a Flutter application that allows users to search for books, view detailed information about them, and add personal notes for each book. It integrates with the Open Library API to provide comprehensive book data.

Features

  • Search for books by title, author, or subject
  • View book details including cover images, publication information, and descriptions
  • Add and manage personal notes for each book
  • Infinite scrolling to load more search results

Screenshots

Screenshot 2025-07-28 at 1 13 58 PM Screenshot 2025-07-28 at 1 14 24 PM Screenshot 2025-07-28 at 1 14 51 PM

Prerequisites

  • Flutter (3.3.0 or higher)
  • Dart SDK (3.8.0 or higher)
  • An IDE (VS Code, Android Studio, or IntelliJ)

Setup

  1. Clone the repository
git clone https://github.com/adjwilli/booknoter.git
cd booknoter
  1. Install dependencies
flutter pub get
  1. Run the app

For development:

flutter run

Please note this app has only been tested and vetted on Chrome, iOS 18.5, MacOS 15.5, and Android SDK 36. Running on Linux or Window (or other versions of the other targets) may require additional set up.

Project Structure

lib/
├── models/          # Data models
├── services/        # API services

Testing

BookNoter includes comprehensive unit tests for all models and services. To run the tests:

flutter test

The testing suite includes:

  • Model tests: Validating model construction, JSON serialization/deserialization, and helper methods
  • Service tests: Ensuring API interactions and data management work correctly

API Integration

BookNoter uses the Open Library API to search for books and retrieve book information. The application makes the following API calls:

  • Search: https://openlibrary.org/search.json?q={query}
  • Cover images: https://covers.openlibrary.org/b/id/{cover_id}-{size}.jpg
  • Work details: https://openlibrary.org/works/{work_id}.json

About

Multi-platform Flutter app to browse Open Library and take notes

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published