Skip to content

README.md

Latest commit

 

History

History
120 lines (90 loc) · 4.13 KB

README.md

File metadata and controls

120 lines (90 loc) · 4.13 KB

QOllama

images

QOllama： A Cross-Platform Qt Client for ollama

QOllama is a powerful and feature-rich client application for Ollama. Built on top of the popular Qt framework, QOllama provides a seamless cross-platform experience, allowing users to enjoy a rich set of customization options and an intuitive interface.

What makes QOllama special?

  • Cross-platform compatibility: Run QOllama on Windows, macOS, or Linux, without any hassle.
  • Rich customization models: Explore customization model and upload what you make.
  • Intuitive user interface: Easily navigate through QOllama's modern and responsive UI.
  • Well-organized codebase: Our project is designed to be easy to learn from and contribute to, making it perfect for developers of all levels.

Take a peek at what you can do with QOllama:

gif

Screenshots

Windows MacOS Linux
image image to be added
Chats page market page settings page
image image image

Directory Structure

  • design: Directory for design-related files.
  • external: Contains external libraries and dependencies.
  • models: Directory for custom models.
  • resources: Contains application resources such as icons, images, and stylesheets.
    • icons: Icon files for the application.
    • images: Image files used in the application.
    • psd: PSD files for design purposes.
    • qss: Qt Style Sheets for customizing the application's appearance.
    • config.json: Configuration file for models path, ollama port, and ets.
  • src: Source code directory.
    • 3rdParty: Third-party libraries and components.
    • buttons: Directory for button components.
    • container: Components related to containers and layouts.
    • display: Components for displaying data and information.
    • include: Header files and external includes.
    • input: Input-related components such as text fields and buttons.
    • network: Networking-related components and functionalities.
    • objects: QOject-related components
    • pages: Application pages and UI components.
    • scripts: Scripts for getting information from the server and processing
  • tests: Test cases and testing-related code.

Installation

Prerequisites

  • Qt 6.3 or higher
  • C++11 or higher
  • CMake
  • Git
  • Python 3 or higher
  • Ollama

Steps

  1. Clone the Repository:

    git clone https://github.com/farleyrunkel/qollama
cd qollama

  2. Initialize Submodules:

    git submodule update --init --recursive

  3. Open the Project: Open the project in Qt Creator or any compatible IDE.

  4. Configure the Project: Ensure that Qt and CMake are properly configured in your IDE. Alternatively, you can configure it manually in the terminal:

    mkdir build
cd build
cmake ..

  5. Build the Project: Build the project using your IDE or run the following command in the terminal:

    make

  6. Run the Application: Run the application through your IDE or execute the built binary:

    ./qollama

Contribution

  1. Fork the repository.
  2. Create your feature branch (git checkout -b feature/new-feature).
  3. Commit your changes (git commit -am 'Add some feature').
  4. Push to the branch (git push origin feature/new-feature).
  5. Open a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgements

  • Thanks to the Qt community for their excellent framework and support.
  • Special thanks to Ollama for providing the model used in this application.

Feel free to modify and expand this README to better fit your project's specifics. If you need any further customization or additional sections, let me know!