spotGPT

Quick Search chatGPT API interface

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

• Node.js (https://nodejs.org/)
• npm (comes with Node.js)

Installing

Here are the steps to get the application running:

Step 1: Clone the repository.

git clone https://github.com/Deadlypinfish/spotGPT.git
cd spotGPT

Step 2: Install the project dependencies.

npm install

Step 3: The application needs your OpenAI API key to function properly. The key can be entered in the settings page within the application.

Running the Application

To run the application:

npm start

Packaging the Application

To package the application into an executable:

npm run package

This will create an executable in the 'release' directory.

Built With

• Electron - The web framework used
• Node.js - Runtime environment
• npm - Dependency Management

Contributing

Please read 'CONTRIBUTING.MD' for details on our code of conduct, and the process for submitting pull requests to us.

License

This project is licensed under the MIT License - see the 'LICENSE.md' file for details.