Skip to content

Extract and display highlights from Kobo (KoboReader.sqlite) and Kindle/KoReader (My Clippings.txt) and send them to Notion or Hardcover.

License

Notifications You must be signed in to change notification settings

TaylanTatli/Hylit

Repository files navigation

Hylit Logo Hylit Logo

Hylit (previously KoboHighlights) is a web application designed to extract and display highlights from the Kobo (KoboReader.sqlite) and Kindle/KoReader (My Clippings.txt) and send them to Notion or Hardcover.

Hylit Preview

📚 Table of Contents

📖 Description

This project enables users to upload their KoboReader.sqlite or My Clippings.txt file and view a list of books with highlights and the highlights themselves. Users can also send these highlights to Notion or Hardcover.

✨ Features

  • Extract highlights from KoboReader.sqlite file (Kobo)
  • Extract highlights from My Clippings.txt file (Kindle/KoReader)
  • Display highlights in a user-friendly interface
  • Send highlights to Notion and Hardcover
  • Save highlights to local storage for offline access
  • Multi-language support (English and Turkish)
  • Docker support for easy deployment
  • Responsive UI

⚙️ Installation

To run the project locally, follow these steps:

📋 Requirements

  • Node.js (>=14.x)
  • pnpm package manager
  • Docker (optional)

🛠️ Steps

  1. Clone the repository:

    git clone https://github.com/TaylanTatli/hylit.git
    cd hylit
  2. Install dependencies:

    pnpm install
  3. (Optional) Create a .env file in the root directory and add your environment variables:

    NEXT_PUBLIC_NOTION_PAGE_ID=your_notion_page_id
    NEXT_PUBLIC_NOTION_API_KEY=your_notion_api_key

    This is only necessary if you want to predefine your page ID and API key. If you don't create this file, you will need to enter your page ID and API key when you send highlights to Notion. These values will be saved to local storage for next time.

  4. Start the development server:

    pnpm run dev

🚀 Usage

  1. Open your browser and navigate to http://localhost:3000.
  2. Upload your KoboReader.sqlite or My Clippings.txt file.
  3. View the list of books and their highlights.
  4. Optionally, send highlights to Notion or Hardcover by entering your API credentials, or download them to your PC.

🐳 Docker Usage

To run the project using Docker, follow these steps:

  1. Build the Docker image:

    docker build -t hylit .
  2. Start the Docker container:

    docker run -p 3000:3000 hylit
  3. Open your browser and navigate to http://localhost:3000.

☁️ Deploy on Vercel / Netlify

You can deploy this project to Vercel or Netlify by clicking the buttons below:

Deploy with Vercel Deploy with Netlify

🔮 Future Plans

  • Improve the user interface and user experience
  • Add more export options (e.g., PDF)

🤝 Contributing

Contributions are welcome! Please open an issue or submit a pull request.

☕ Supporting The Project

If you like the project and want to support me, You can Buy Me A Coffee

📜 License

Copyright (C) 2025 Taylan Tatli

This project is licensed under the GNU Affero General Public License v3.0 (AGPLv3).

You are free to use, modify, and distribute this software under the terms of the AGPLv3. See the LICENSE file for the full text.

About

Extract and display highlights from Kobo (KoboReader.sqlite) and Kindle/KoReader (My Clippings.txt) and send them to Notion or Hardcover.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published