vikarti.anatra/typingmind
1
0
Fork 0
mirror of https://github.com/TypingMind/typingmind.git synced 2025-04-03 11:59:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Tony Dinh 2024-02-09 23:28:02 +07:00
parent f50ed9df1a
commit 9a574d3131
2 changed files with 89 additions and 20 deletions

11
LICENSE.md
View file

@ -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.

98
README.md
View file

@ -1,29 +1,33 @@
<h1 align="center">
<img src="https://www.typingmind.com/banner.png" alt="Typing Mind - A better UI for ChatGPT" height="150"/>
<img height="150" alt="Typing Mind - A better UI for ChatGPT" src="https://www.typingmind.com/banner.png" />
</h1>
<div align="center">
Typing Mind is the most advanced Chat UI frontend for AI models like ChatGPT, Claude, Gemini, and open-source models
<br/>
<img alt="Users: 18,000+" src="https://img.shields.io/badge/users-18%2C000%2B-green">
<a href="https://www.typingmind.com/discord">
<img alt="Discord" src="https://img.shields.io/discord/1087527241505853520?style=flat&logo=discord">
</a>
<img alt="Uptime Robot ratio (30 days)" src="https://img.shields.io/uptimerobot/ratio/m796342452-0b8b12da5c8a5f4bd1df4fbb">
<img alt="Version: Self-host" src="https://img.shields.io/badge/version-self%20host-green">
<a href="https://x.com/TypingMindApp">
<img alt="X (formerly Twitter) Follow" src="https://img.shields.io/twitter/follow/TypingMindApp">
</a>
<img alt="Documentations" src="https://img.shields.io/badge/Documentations-black?logo=readthedocs">
<a href="https://setapp.com/apps/typingmind">
<img alt="Setapp Rating: 91%" src="https://img.shields.io/badge/Setapp-946%20ratings-green?logo=setapp">
</a>
<a href="https://www.producthunt.com/posts/typing-mind?utm_source=badge-top-post-badge&utm_medium=badge&utm_souce=badge-typing-mind">
<img alt="Product Hunt: Product of the Day" src="https://img.shields.io/badge/Product%20of%20The%20Day-%231-orange?logo=producthunt">
</a>
<a href="https://x.com/TypingMindApp">
<img alt="X (formerly Twitter) Follow" src="https://img.shields.io/twitter/follow/TypingMindApp">
</a>
<br/>
<br/>
<i>Typing Mind is the most advanced Chat UI frontend for AI models like ChatGPT, Claude, Gemini, and open-source models</i>
</div>
<img width="1360" alt="Screenshot of Typing Mind app" src="https://github.com/TypingMind/typingmind/assets/4214509/d9c4a4df-51ba-4f36-8406-33c1e6f7ee1c">
<div align="center">
@ -31,12 +35,12 @@
<a href="https://www.producthunt.com/posts/typing-mind?utm_source=badge-top-post-badge&amp;utm_medium=badge&amp;utm_souce=badge-typing-mind" target="_blank"><img src="https://www.typingmind.com/assets/product-hunt/top-post-badge.svg" alt="Typing Mind - A better UI for ChatGPT | Product Hunt" width="250" height="54" style="width: 250px; height: 54px;"></a>
</div>
## 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 |
|---------------|--------------|---------------|
| <img width="1284" alt="Xnapper-2024-02-09-23 43 05" src="https://github.com/TypingMind/typingmind/assets/4214509/5e7e288e-8ecc-4706-a2d2-d39a50669058"> | <img width="1284" alt="gpt4 vision" src="https://github.com/TypingMind/typingmind/assets/4214509/fe55a28a-8f05-431c-8ce1-859be0236c73"> | <img width="1283" alt="custom model" src="https://github.com/TypingMind/typingmind/assets/4214509/aa311abd-6314-49d4-a413-cb0e9bdf617d"> |
| AI Characters | Voice Input | Plugins |
|---------------|--------------|---------------|
| <img width="1284" alt="ai characters" src="https://github.com/TypingMind/typingmind/assets/4214509/12570e1f-0015-4b08-8355-70d77b177421"> | <img width="1284" alt="voice input" src="https://github.com/TypingMind/typingmind/assets/4214509/bc8f79f7-571d-4c94-ab69-e75e7b129992"> | <img width="1284" alt="plugins" src="https://github.com/TypingMind/typingmind/assets/4214509/9c0945d2-957b-4a41-83a4-c02968c7bed9"> |
## 📝 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