Descr.ai.be

Project Description

Overview The Bookmark Context AI Chrome Extension revolutionizes the way users manage and utilize their bookmarks by adding intelligent context-aware features. This extension enhances the traditional bookmarking experience by providing users with dynamic summaries, keywords, and notes for each bookmark. When a user hovers over a bookmark, the extension displays this contextual information in a tooltip, making it easier to recall and utilize saved resources effectively.

Key Features

1. Contextual Bookmarks: Save and categorize bookmarks with AI-generated summaries, keywords, and notes.
2. Hover Tooltips: Display contextual information in tooltips when hovering over bookmarks.
3. Enhanced Bookmarking: Bookmark specific paragraphs, images, or elements on a webpage.
4. Bookmarks Management: Access, search, and sort all bookmarks through an easy-to-use interface.
5. User Authentication: Securely manage bookmarks with user authentication through Google accounts.
6. Custom AI Models: Integrate custom AI models for generating summaries and tags.

Technology Stack

Installation

1. Install the NodeJS LTS (v20.14.0) Click Here

2. Install the latest Python version (v3.12.4) Click Here

3. Node based project:

   cd <folder_name>
   npm i
   npm run dev

Setup

1. Create a fork on the repository
2. Clone the forked repository

   git clone https://github.com/upes-open/OSoC-24-descr.ai.be

3. Open the cloned repository in your desired code editor (eg: VS Code, Zed, Sublime Text)

Contributing

1. Create a branch: git checkout -b <your_username>
2. Issues: Find the active issues in the issues tab.
3. Comment on the issue, and get yourself assigned to it.
4. Complete the issue and raise a Pull Request containing the issue number, eg: Fixes #23

   git add .
   git commit -m "<commit_message>"
   git push -u origin <branch_name>

5. Wait for the code review and pull request merge.

Rules

1. There are 3 level of toughness of the issues.
   1. Easy: The issues which are beginner level and easy to solve. (10 points)
   2. Medium: The issues which are intermediate level and a bit tricky to solve. (20 points)
   3. Medium: The issues which are advanced level and includes advanced concept of the technology stack to solve. (30 points)
2. Direct commit on main branch is restricted. Creating a branch is mandatory.
3. Pull request without the issue number will not be merged.
4. Scores will be weekly declared on the OPEN's website and discord.
5. All the discussion has to be performed on the Discord sever or GitHub.
6. Raising and solving a self issue will not be considered as legit contribution. Read Innovation Center

Inovation Center

If a contributor has to introduce a new feature that is not mentioned in the issues, the conrributor has to discuss the feature with the repository maintainer. The maintainer will raise the issue and assign it to the respective contributor.

Help center

In case of any problem, kindly reach out to us on our mail [email protected].

Disclaimer

This project is under the OSoC'24. OSoC'24 is organized by OPEN Community, UPES. All the projects are open source with a copyleft license. Kindly go through the licensing terms thoroughly to avoid any issues in code distribution. LICENSE. Any violation of the licensing terms will lead to unavoidable consequences

LICENSE