Skip to content

Latest commit

 

History

History
45 lines (39 loc) · 1.68 KB

README.md

File metadata and controls

45 lines (39 loc) · 1.68 KB

📑 Goodmarks

✨ A self-hostable, semantically searchable bookmarks extension for Chrome and Firefox using Vector Databases ✨

✨ Features

  • Fire and forget bookmarks. Simply save them by clicking on the extension.
  • Automatic title and description extraction.
  • Tag bookmarks into categories you choose.
  • Goodmarks indexes the content of website you are saving.
  • Search for bookmarks based on content using natural language.
  • Filter your searches by domain, tags and dates.
  • Multiple accounts with user management.

⚙️ Installation

Client Installation

  1. Clone the repository
    git clone https://github.com/shaun-mathew/Goodmarks.git
    cd goodmarks-client
    npm install
    npm run build
  2. Load the unpacked extension into your browser (Note: Developer mode must be enabled). Select the goodmarks-client/dist folder. Menu -> Extensions -> Load unpacked

Server Installation

git clone https://github.com/shaun-mathew/Goodmarks.git
cd goodmarks-server
docker compose up -d
npm install
npm run start

📄 TODO

  • Create a singular docker image for easier installation
  • Precompile extension for easy client-side installation
  • Add boolean search capabilities
  • Add hybrid text search
  • Add dark mode