Skip to content
This repository has been archived by the owner on Sep 26, 2023. It is now read-only.

Commit

Permalink
Update discord link
Browse files Browse the repository at this point in the history
  • Loading branch information
ramon-victor committed Aug 17, 2023
1 parent 47dbcb6 commit 6dfd8e5
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 33 deletions.
98 changes: 66 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,24 @@
# FreeGPT WebUI - Chimera Version

## Models
- gpt-3.5-turbo
- gpt-3.5-turbo-0301
- gpt-3.5-turbo-16k
- gpt-4
- gpt-4-0314
- gpt-4-32k
- oasst-sft-6-llama-30b
- llama-2-70b-chat

- gpt-3.5-turbo
- gpt-3.5-turbo-0301
- gpt-3.5-turbo-16k
- gpt-4
- gpt-4-0314
- gpt-4-32k
- oasst-sft-6-llama-30b
- llama-2-70b-chat

<br>

## 🔑 <strong>REQUIRE API KEY BUT IT'S FREE</strong>
Get your API key from the [ChimeraGPT Discord](https://discord.gg/chimeragpt).
## 🔑 <strong>REQUIRE API KEY BUT IT'S FREE</strong>

Get your API key from the [ChimeraGPT Discord](https://discord.gg/hfmwJzctC6).

## Project Hosting and Demonstration 🌐🚀

The project is hosted on multiple platforms to be tested and modified.
|Plataform|Status|API Key|Free|Repo|Demo|
|--|--|--|--|--|--|
Expand All @@ -24,125 +27,156 @@ The project is hosted on multiple platforms to be tested and modified.
|[replit](https://replit.com/)|![Active](https://img.shields.io/badge/Active-brightgreen)|☑️|☑️|[FreeGPT WebUI - Chimera Version](https://replit.com/@ramonvc/freegpt-webui-chimera)|[Chat](https://freegpt-webui-chimera.ramonvc.repl.co/chat/)
|[hugging face](https://huggingface.co)|![Active](https://img.shields.io/badge/Active-brightgreen)|☑️|☑️|[FreeGPT WebUI - Chimera Version](https://huggingface.co/spaces/monra/freegpt-webui-chimera/tree/main)|[Chat](https://huggingface.co/spaces/monra/freegpt-webui-chimera)

## Table of Contents
- [Getting Started](#getting-started-white_check_mark)
- [Cloning the Repository](#cloning-the-repository-inbox_tray)
- [Install Dependencies](#install-dependencies-wrench)
- [Running the Application](#running-the-application-rocket)
- [Docker](#docker-)
- [Prerequisites](#prerequisites)
- [Running the Docker](#running-the-docker)
- [Incorporated Projects](#incorporated-projects-busts_in_silhouette)
- [WebUI](#webui)
- [API FreeGPT](#api-g4f)
- [Star History](#star-history)
- [Legal Notice](#legal-notice)
## Table of Contents

- [Getting Started](#getting-started-white_check_mark)
- [Cloning the Repository](#cloning-the-repository-inbox_tray)
- [Install Dependencies](#install-dependencies-wrench)
- [Running the Application](#running-the-application-rocket)
- [Docker](#docker-)
- [Prerequisites](#prerequisites)
- [Running the Docker](#running-the-docker)
- [Incorporated Projects](#incorporated-projects-busts_in_silhouette)
- [WebUI](#webui)
- [API FreeGPT](#api-g4f)
- [Star History](#star-history)
- [Legal Notice](#legal-notice)

##

# Getting Started :white_check_mark:
To get started with this project, you'll need to clone the repository and have [Python](https://www.python.org/downloads/) installed on your system.

# Getting Started :white_check_mark:

To get started with this project, you'll need to clone the repository and have [Python](https://www.python.org/downloads/) installed on your system.

## Cloning the Repository :inbox_tray:
Run the following command to clone the repository:

Run the following command to clone the repository:

```
git clone https://github.com/ramonvc/freegpt-webui.git
```

### Switching to the chimeragpt-version Branch :arrows_counterclockwise:

Run the following command to switch to the chimeragpt-version branch:

```
git checkout chimeragpt-version
git checkout chimeragpt-version
```

## Install Dependencies :wrench:
## Install Dependencies :wrench:

In the project directory, install the dependencies:

```
pip install -r requirements.txt
```

## Setting up the API Key and .env :key:

Before starting the application, you need to obtain an API key from ChimeraGPT and set up the .env file.

### Get your API key
Get your API key from the [ChimeraGPT Discord](https://discord.gg/chimeragpt).

Get your API key from the [ChimeraGPT Discord](https://discord.gg/hfmwJzctC6).

### Create .env

In the project directory, create a file called .env.
Open the .env file and add the following line:

```
CHIMERA_API_KEY=<API-Key>
CHIMERA_API_KEY=<API-Key>
```

## Running the Application :rocket:

To run the application, run the following command:

```
python run.py
```

Access the application in your browser using the URL:

```
http://127.0.0.1:1338
```

or

```
http://localhost:1338
```

## Docker 🐳

### Prerequisites

Before you start, make sure you have installed [Docker](https://www.docker.com/get-started) on your machine.

### Get your API key
Get your API key from the [ChimeraGPT Discord](https://discord.gg/chimeragpt).

Get your API key from the [ChimeraGPT Discord](https://discord.gg/hfmwJzctC6).

### Running the Docker

Pull the Docker image from Docker Hub:

```
docker pull ramonvc/freegpt-webui-chimera
```

Run the application using Docker:

```
docker run -p 1338:1338 -e CHIMERA_API_KEY=<API-Key> ramonvc/freegpt-webui-chimera
```

Access the application in your browser using the URL:

```
http://127.0.0.1:1338
```

or

```
http://localhost:1338
```

When you're done using the application, stop the Docker containers using the following command:

```
docker stop <container-id>
```

## Incorporated Projects :busts_in_silhouette:

I highly recommend visiting and supporting both projects.

### ChimeraGPT

The free API was incorporated from the [ChimeraGPT](https://chimeragpt.adventblocks.cc/).

### WebUI

The application interface was incorporated from the [chatgpt-clone](https://github.com/xtekky/chatgpt-clone).

### API G4F

The API controller has been built in from [GPT4Free](https://github.com/xtekky/gpt4free).

<br>

## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=ramonvc/freegpt-webui&type=Timeline)](https://star-history.com/#ramonvc/freegpt-webui&Timeline)

<br>

## Legal Notice

This repository is _not_ associated with or endorsed by providers of the APIs contained in this GitHub repository. This
project is intended **for educational purposes only**. This is just a little personal project. Sites may contact me to
improve their security or request the removal of their site from this repository.
Expand Down
2 changes: 1 addition & 1 deletion client/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@
<i class="fa-brands fa-github"></i>
<span class="conversation-title">freegpt-webui-chimera</span>
</a>
<a class="info" href="https://discord.gg/chimeragpt" target="_blank">
<a class="info" href="https://discord.gg/hfmwJzctC6" target="_blank">
<i class="fa-brands fa-discord"></i>
<span class="conversation-title">ChimeraGPT</span>
</a>
Expand Down

0 comments on commit 6dfd8e5

Please sign in to comment.