/chatgpt-desktop

An Electron wrapper for ChatGPT, allowing users to interact with the language model through a standalone desktop application.

Primary LanguageJavaScriptGNU Affero General Public License v3.0AGPL-3.0


Logo

ChatGPT Desktop

An Electron wrapper for ChatGPT, allowing users to interact with the language model through a standalone desktop application.

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. License

About The Project

ChatGPT Desktop Screen Shot

This project is an Electron wrapper for ChatGPT, allowing users to interact with the language model through a standalone desktop application. It leverages the power of Node.js and Chromium to provide a cross-platform experience.

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

You will require node.js, npm and electron to run this project.

  • node

    To check if you have Node.js installed, run the command node -v in your terminal. If you see a version number, you have Node.js installed. If not, download it from the official Node.js website.

  • npm

    To check if you have npm installed, run the command npm -v in your terminal. If you see a version number, you have npm installed. If not, it should be included with your Node.js installation.

  • electron

    To install Electron globally on your machine, run the command npm install -g electron. This will allow you to use the electron command from anywhere on your machine.

Installation

Instruction on setup and install.

  1. Get a free API Key at https://example.com
  2. Clone the repo
    git clone https://github.com/DeadBranches/chatgpt-desktop.git
  3. Install NPM package dependancies
    npm install

(back to top)

Usage

Once you've installed and set up the project, you can use the following commands to run it:

  • npm start: This command launches the application in development mode.
  • npm run build: This command builds the application for production, generating a distributable package in the dist folder.

(back to top)

Roadmap

  • Feature 1
  • Feature 2
  • Feature 3
    • Nested Feature

(back to top)

License

Distributed under the GNU Affero General Public License v3.0. See LICENSE.txt for more information.

(back to top)