README.md

Ollamazing

A Web extension to use local AI models
Explore the docs »

Chrome Web store · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

(back to top)

Built With

• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

This extension is built using WXT and React, so ensure to install Node.Js or Bun for a running environment.

Prerequisites

• Package manager: We can use any package managers like npm, yarn, pnpm, bun. This project is currently installed by npm, that the field package-lock.json exists.
• Ollama: This extension uses Ollama, so you have to have an Ollama server from anywhere, installing on local for example. For more details, read Ollama.

  Important: If you run Ollama on local machine, ensure to setup the OLLAMA_ORIGINS to allow the extension can connect to the server For more detail, read Ollama FAQ, set the OLLAMA_ORIGINS to * or chrome-extension://* or the domain you want to allow.

Installation

1. Clone the repo

   git clone https://github.com/buiducnhat/ollamazing.git

2. Install dependencies

   npm install
   # or yarn install, pnpm install, bun install

(back to top)

Usage

To run local development, run the following command:

npm run dev
# or yarn run dev, pnpm run dev, bun run dev

then, a new browser window will open with the extension installed.

(back to top)

Roadmap

• Basic, chat with AI assistant.
• Improve UI, UX.
  • Adapt for almost popular models's message format.
  • Interact with images.
• Setup sync global state with extension storage.
• Preferences settings.
  • Light/Dark theme.
  • Multiple languages.
• Manage model, use more Ollama APIs.
• Content script to be injected into the pages when selecting text.
  • Add utility to translate text.
  • Add utility to summarize paragraph.
• Add context menu besides the text selection for web pages.
• Add short key to open the extension.
• Feature multiple chat, history chat.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Top contributors:

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Bùi Đức Nhật - nhaths4701@gmail.com

Project Link: https://github.com/buiducnhat/ollamazing

Support the project

(back to top)

Star History