Skip to content
fingerthief edited this page May 18, 2024 · 8 revisions

Welcome to the MinimalChat Wiki

Welcome to the official wiki for MinimalChat, your go-to guide for using and understanding this powerful, open-source large language model (LLM) chat web application. MinimalChat is designed to be self-contained, ensuring all your conversations are stored locally for privacy and security.

Build Status Version License

Try MinimalGPT/MinimalClaude/MinimalCustom (Public Site)


Table of Contents

Features

  • Mobile Swipe Gestures: Swiping to the left or right on the message input box on a mobile device will quickly open the Settings or Conversations window.
  • Self-contained: All conversations are stored on your device.
  • Multiple Models Supported: Including GPT-3.5-Turbo, GPT-4, Claude 3, and more.
  • Mobile Installation: Installable as a PWA for a seamless mobile experience.
  • API Integration: Supports OpenAI and other APIs for flexible model interaction. This makes connecting to Locally hosted models possible a local API endpoint.
  • Vision Support

Quick Start

Self Host with Docker

Pull the Docker image with:

docker pull tannermiddleton/minimal-chat:latest

API Keys

Before you start, ensure you have the necessary API keys for the service(s) you want to use:

Mobile Installation

Install MinimalChat on your mobile device for an app-like experience:

  • iOS: Use the Share button in Safari and select Add to Home Screen.
  • Android: Select Install App from your browser menu.

FAQ

  • Is MinimalGPT free to use? Yes, it's open-source and free, but requires your own API keys.
  • Can I use it without an internet connection? Yes, with local hosting of LLMs like LM Studio.
  • Are my conversations secure? Yes, they are stored locally and only necessary API calls are made.
  • Mobile device compatibility? Yes, fully responsive and installable as a PWA.

Contributing

Interested in contributing? Check out how you can contribute.

License

MinimalChat is released under the MIT License.


For more detailed information on setup, features, and troubleshooting, please navigate through the Table of Contents. Enjoy using MinimalChat!