chatgptWithMidjourney  by Zo3i

Web UI for ChatGPT, optionally with Midjourney image generation

created 2 years ago
420 stars

Top 71.0% on sourcepulse

GitHubView on GitHub
Project Summary

This project provides a well-designed, one-click deployable ChatGPT web UI, targeting users who want a private, customizable ChatGPT interface. It offers features like Markdown support, prompt templates, and local data storage, enhancing user experience and privacy.

How It Works

The UI is built with a focus on ease of deployment and user experience, leveraging Vercel for one-click deployment. It supports streaming responses, Markdown rendering (including LaTeX and Mermaid), and PWA capabilities. A key architectural choice is storing all data locally in the browser, prioritizing user privacy. It also includes features for creating, sharing, and debugging chat tools via prompt templates.

Quick Start & Requirements

  • Deploy: One-click deployment via Vercel (link provided in README).
  • Prerequisites: OpenAI API Key is required. Optional environment variables include CODE (access password), BASE_URL (for custom OpenAI endpoints), OPENAI_ORG_ID, HIDE_USER_API_KEY, and DISABLE_GPT4. For Midjourney integration, MIDJOURNEY_API_KEY, MIDJOURNEY_API_URL, and MIDJOURNEY_IMG_PROXY are needed.
  • Local Development: Requires Node.js and Yarn.
  • Docker: docker pull zo3i/chatgptwithmidjourney and docker run -d -p 3000:3000 -e OPENAI_API_KEY="sk-xxxx" -e CODE="your-password" zo3i/chatgptwithmidjourney.
  • Resources: Minimal client size (~5MB).

Highlighted Details

  • One-click free deployment on Vercel in under 1 minute.
  • Full Markdown support: LaTeX, Mermaid, code highlighting.
  • Privacy-first: all data stored locally in the browser.
  • Prompt templates for creating, sharing, and debugging chat tools.
  • Compatibility with self-hosted LLMs (RWKV-Runner, LocalAI).
  • Midjourney integration via API keys and proxy settings.

Maintenance & Community

  • Active development with a roadmap including plugins and desktop app support.
  • Community support via Discord.
  • "Buy Me a Coffee" link for developer donations.

Licensing & Compatibility

  • Licensed under the Anti 996 License. This license aims to prevent overwork and may have implications for commercial use or redistribution depending on interpretation.

Limitations & Caveats

The project explicitly states that user login, account management, and cloud sync are not planned features. Automatic updates require forking the repository and enabling GitHub Actions workflows due to Vercel's deployment model.

Health Check
Last commit

2 years ago

Responsiveness

1 day

Pull Requests (30d)
0
Issues (30d)
0
Star History
1 stars in the last 90 days

Explore Similar Projects

Feedback? Help us improve.