Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/skywolfmo/bookmarksai
Chrome Bookmarks on steroids
https://github.com/skywolfmo/bookmarksai
Last synced: 3 months ago
JSON representation
Chrome Bookmarks on steroids
- Host: GitHub
- URL: https://github.com/skywolfmo/bookmarksai
- Owner: skywolfmo
- License: gpl-3.0
- Created: 2024-01-01T23:29:57.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2024-01-06T13:58:22.000Z (10 months ago)
- Last Synced: 2024-06-16T15:42:01.232Z (5 months ago)
- Language: JavaScript
- Homepage: https://chromewebstore.google.com/detail/bookmarksai/gapcljmiheclbeoagghkdflildhbahha?hl=en
- Size: 536 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 23
-
Metadata Files:
- Readme: readme.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Bookmarks AI
Bookmarks AI is a Chrome extension that leverages artificial intelligence to enhance your web browsing experience. It allows you to summarize bookmarked pages, apply custom prompts for detailed insights, and more.
## Getting Started
To run Bookmarks AI locally, follow these steps:
### Prerequisites
- Google Chrome Browser
- Node.js and npm installed
### Installation
1. Clone the repository:
```
git clone https://github.com/skywolfmo/bookmarksai
```
2. Navigate to the project directory and install dependencies:
```
npm install
```
3. Build the project:
```
npm run build
```
### Adding Extension to Chrome
1. Open Google Chrome and navigate to `chrome://extensions/`.
2. Enable `Developer mode`.
3. Click `Load unpacked` and select the `dist` folder from the cloned repository.
## Features
- AI-powered content analysis using Google's Gemini Pro API.
- Customizable prompts for tailored content insights.
- Options to process content either individually or combined.
## Usage
To use the AI functionality of the Bookmarks AI Chrome extension, you will need to obtain an API key from the Gemini Pro website by Google. Here's a brief summary of how to get the API key:
1. Visit the Gemini Pro API website: [Google Gemini Pro API](https://makersuite.google.com/app/apikey).
2. Follow the instructions to register and create an API key.
3. Once you have the API key, enter it into the top of Bookmarks AI extension and click on Save API Key, this will save it in the local storage.
This API key is essential for enabling the AI features in the extension. Make sure to keep it secure and follow Google's guidelines for API usage.
## Contributing
Contributions to Bookmarks AI are welcome.
## License
This project is licensed under the GNU V3 License - see the LICENSE file for details.
## Acknowledgments
- Google's Gemini Pro API for providing AI capabilities.
- We used Bard and ChatGPT to guide us through the process of creating this extension
- All contributors who have helped shape Bookmarks AI.
- https://github.com/kylelobo/The-Documentation-Compendium