From 9a574d3131e86d15330b3792e3e3971251c53632 Mon Sep 17 00:00:00 2001 From: Tony Dinh Date: Fri, 9 Feb 2024 23:28:02 +0700 Subject: [PATCH] Update README.md --- LICENSE.md | 11 +++--- README.md | 98 ++++++++++++++++++++++++++++++++++++++++++++++-------- 2 files changed, 89 insertions(+), 20 deletions(-) diff --git a/LICENSE.md b/LICENSE.md index e573d1f..c8fc479 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -2,12 +2,11 @@ NOTE: This is NOT an open-source software. -This repository hosts the static self-host version of https://www.typingmind.com -for Typing Mind's users. - -Please see https://www.typingmind.com/self-host-faqs for more information. +The source code here is compiled and is intended only for self-host users of Typing Mind to host and receive updates. Please see [Self-host FAQs](https://docs.typingmind.com/static-self-host/static-self-host-faqs) for more information. - You have access to the compiled code of the app. - You have permission to deploy and use the compiled code on your own server. -- You do not have permissions to modify or redistribute the compiled code. -- You do not have permissions to share or resell the compiled code. +- You do not have permission to modify or redistribute the compiled code. +- You do not have permission to share or resell the compiled code. + +Please see https://www.typingmind.com/self-host-faqs for more information. diff --git a/README.md b/README.md index a6db739..19fe180 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,33 @@

- Typing Mind - A better UI for ChatGPT + + Typing Mind - A better UI for ChatGPT +

+ + Typing Mind is the most advanced Chat UI frontend for AI models like ChatGPT, Claude, Gemini, and open-source models +
+ Users: 18,000+ Discord Uptime Robot ratio (30 days) - Version: Self-host - - X (formerly Twitter) Follow - + Documentations Setapp Rating: 91% Product Hunt: Product of the Day - + + X (formerly Twitter) Follow +
-
-Typing Mind is the most advanced Chat UI frontend for AI models like ChatGPT, Claude, Gemini, and open-source models
+ Screenshot of Typing Mind app
@@ -31,12 +35,12 @@ Typing Mind - A better UI for ChatGPT | Product Hunt
-## Features +## 📜 Features - 🤖 Support multi models: - ChatGPT, Claude, Gemini, Azure OpenAI, Perplexity AI, Mixtral AI, LLama - Adding custom endpoint, custom models (e.g., Open Router), and locally hosted models (e.g., LocalAI, Ollama) - Custom model parameters: Temperature, Frequency_penalty, Presence_penalty, Top_P, Top_K, etc. -- 🚀 Advanced Features: GPT-4 Vision, Document Uploads, DALL-E 3, Web Search, Text-to-Speech, Plugins +- 🚀 Advanced Features: GPT-4 Vision, Document Uploads, DALL-E 3, Web Search, Text-to-Speech, Whipsper, Plugins - 💬 Chat Management: - Tags, Search, Folders, Share, Backup & Sync, Import/Export, Migrate from ChatGPT - Fork Chat (conversation branching), Edit Message, Pin @@ -46,15 +50,81 @@ - Voice Input, Text-to-Speech, Sound Notification - Light/Dark mode, Hotkeys, Responsive & Mobile Friendly, Wide Screen Support - 🧩 Integrations: Web Search, Plugins System (develop your own plugins), Search Keyword Suggestions -- 🇺🇸 Multilingual: 🇩🇪 German, 🇨🇳 Mandarin, 🇻🇳 Vietnamese, 🇬🇷 Greek, 🇫🇷 French, 🇮🇹 Italian, 🇷🇺 Russian, 🇺🇦 Ukrainian, 🇪🇸 Spanish, 🇵🇹 Portuguese, 🇱🇺 Luxembourgish -- 📦 **[Typing Mind Custom](https://custom.typingmind.com/)**: - - Host a customized version of Typing Mind with custom branding, Self-host, customized UI +- 🇺🇸 Multilingual: + - 🇺🇸 English 🇩🇪 German, 🇨🇳 Mandarin, 🇻🇳 Vietnamese, 🇬🇷 Greek, 🇫🇷 French, 🇮🇹 Italian + - 🇷🇺 Russian, 🇺🇦 Ukrainian, 🇪🇸 Spanish, 🇵🇹 Portuguese, 🇱🇺 Luxembourgish +- 📦 [Typing Mind Custom](https://custom.typingmind.com/) (for teams): + - Host a customized version of Typing Mind with custom branding, self-host, customized UI - Team sharing: Prompts Library, AI Characters - User Management, Access Control, Connect Internal Data, APIs -## Getting started +## 👋 Overview + +Typing Mind is a Chat UI frontend that allows you to use AI chats from all popular AI models with your API key (ChatGPT, Claude, Azure OpenAI, Gemini, etc.). + +By using the API key with a Chat UI frontend like Typing Mind, you unlock the following benefits: + +- You only pay for what you use (instead of a monthly subscription like ChatGPT Plus) +- Your chat conversation will NOT be used for training by OpenAI/Claude/etc. +- Chat with multiple models conveniently within a unified interface +- Enjoy a professional, advanced chat UI with tons of features + +Typing Mind is **offline first** and **private by default**. All your data, messages, and API keys are stored locally on your device, and no one can see them except you. + +This is the _Static Self-host Version_ of Typing Mind ([www.typingmind.com](https://www.typingmind.com/)). By running the static self-host version, you can use Typing Mind from your private server or from a local device. Typing Mind is free to use with some basic features, a license key is needed to unlock all advanced features. See our [pricing plans](https://www.typingmind.com/pricing) for more information. + +## 🚀 Getting started + +To run the app locally on your device or private server: 1. Clone the repo 2. Install dependencies: `yarn install` or `npm install` 3. Start the server: `yarn start` or `npm run start` +4. App will run at `localhost:3000` by default. + +Optionally, you can use any other static web server to host the `src` folder. + +**Note**: if you run the app on hostnames other than `localhost`, you must use HTTPS to make sure all app features work. + +## 🔗 Connect to local models + +1. Open the app +2. Click the model dropdown → Model Settings → Add Custom Models +3. Enter your custom model details: Endpoint, Model ID. Custom headers and body parameters are supported. +4. Click "Test" and then "Add Model". + +If you face CORS issue, make sure to run your local model in CORS mode. + +Read the official documents: +- [Set up local models with Local AI (LLama, GPT4All, Vicuna, Falcon, etc.)](https://docs.typingmind.com/chat-models-settings/set-up-local-models-with-local-ai-(llama-gpt4all-vicuna-falcon-etc.)) +- [Use with Azure OpenAI](https://docs.typingmind.com/chat-models-settings/use-azure-openai) +- [Use with OpenRouter Models](https://docs.typingmind.com/chat-models-settings/use-openrouter-models) +- [Use with Fine-tunned models (OpenAI)](https://docs.typingmind.com/chat-models-settings/fine-tuning-models) +- [Use with Mixtral AI](https://docs.typingmind.com/chat-models-settings/use-with-mistral-ai) +- [Use with Perplexity AI](https://docs.typingmind.com/chat-models-settings/use-with-perplexity-ai) + + +## 📸 Screenshots + +| Home page | GPT-4 Vision | Custom Models | +|---------------|--------------|---------------| +| Xnapper-2024-02-09-23 43 05 | gpt4 vision | custom model | + +| AI Characters | Voice Input | Plugins | +|---------------|--------------|---------------| +| ai characters | voice input | plugins | + +## 📝 Updates & Changelogs + +To update, simply `git pull` and restart your server. + +Change logs are available here: https://www.typingmind.com/changelog + +_The static self-host version updates are delayed from 1 or 2 versions compared to the latest versions on [www.typingmind.com](https://www.typingmind.com)_ + +## 💡 Feedback / Ideas / Bugs + +Please submit your ideas to https://www.typingmind.com/ideas + +For bug reports and customer support, please contact support@typingmind.com