Skip to content

Commit cf462a7

Browse files
Add Quick Start link to Releases
1 parent 94fb69b commit cf462a7

File tree

1 file changed

+43
-99
lines changed

1 file changed

+43
-99
lines changed

README.md

Lines changed: 43 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,16 @@ FreeGPT is a modern, privacy-focused AI chat application that you run on your ow
44

55
---
66

7+
## 🚀 Quick Start (For Users)
8+
9+
**Don't want to install anything?**
10+
1. Go to [Releases](https://github.com/alexandersomosi/freegpt/releases).
11+
2. Download the latest `FreeGPT.exe`.
12+
3. Double-click to run!
13+
4. Your browser will open automatically at `http://localhost:8000`.
14+
15+
---
16+
717
## 🌟 Features
818
* **Chat with Files:** Upload documents and the AI will answer based on their content.
919
* **Private:** Your documents stay on your computer.
@@ -13,107 +23,41 @@ FreeGPT is a modern, privacy-focused AI chat application that you run on your ow
1323

1424
---
1525

16-
## 📦 Installation Guide (Step-by-Step)
17-
18-
Follow these instructions carefully to set up the application on your computer.
19-
20-
### Prerequisites (Install these first)
21-
22-
Before you begin, you need to install two programs on your computer:
23-
24-
1. **Node.js (for the frontend interface)**
25-
* Download and install "LTS" version from: [https://nodejs.org/](https://nodejs.org/)
26-
* During installation, just click "Next" through all the steps.
27-
28-
2. **Python (for the backend logic)**
29-
* Download and install Python 3.10 or newer from: [https://python.org/](https://www.python.org/downloads/)
30-
* **IMPORTANT:** During installation, check the box that says **"Add Python to PATH"** at the bottom of the installer window before clicking "Install Now".
31-
32-
---
33-
34-
### Step 1: Download the Code
35-
36-
1. Click the green **"<> Code"** button at the top of this GitHub page.
37-
2. Select **"Download ZIP"**.
38-
3. Extract (unzip) the downloaded file to a folder on your computer (e.g., `Documents/FreeGPT`).
39-
40-
---
41-
42-
### Step 2: Set up the Backend (The Brain)
43-
44-
This runs the logic and processes your files.
45-
46-
1. Open your computer's terminal (Command Prompt on Windows, Terminal on Mac).
47-
2. Navigate to the project folder you just extracted.
48-
* *Tip:* Type `cd ` (with a space) and then drag the folder into the terminal window, then press Enter.
49-
* Example: `cd C:\Users\YourName\Documents\FreeGPT`
50-
3. Enter the backend folder:
51-
```bash
52-
cd backend
53-
```
54-
4. Create a virtual environment (keeps things clean):
55-
```bash
56-
python -m venv venv
57-
```
58-
5. Activate the environment:
59-
* **Windows:**
60-
```bash
61-
venv\Scripts\activate
62-
```
63-
* **Mac/Linux:**
64-
```bash
65-
source venv/bin/activate
66-
```
67-
*(You should see `(venv)` appear at the start of your command line)*
68-
6. Install the required libraries:
69-
```bash
70-
pip install -r requirements.txt
71-
```
72-
7. Start the Backend Server:
73-
```bash
74-
python main.py
75-
```
76-
✅ You should see: `INFO: Uvicorn running on http://0.0.0.0:8000`
77-
**Do NOT close this window.**
78-
79-
---
80-
81-
### Step 3: Set up the Frontend (The Interface)
82-
83-
This runs the visual chat website.
84-
85-
1. **Open a NEW Terminal window** (keep the previous one running!).
86-
2. Navigate to the project folder again (same as Step 2.2).
87-
* Example: `cd C:\Users\YourName\Documents\FreeGPT`
88-
3. Install the interface dependencies:
89-
```bash
90-
npm install
91-
```
92-
4. Start the Interface:
93-
```bash
94-
npm run dev
95-
```
96-
✅ You should see: `Local: http://localhost:5173/`
26+
## 📦 Installation Guide (For Developers)
27+
28+
### Prerequisites
29+
* Node.js (v18+)
30+
* Python (v3.10+)
31+
32+
### Step 1: Clone the repository
33+
```bash
34+
git clone https://github.com/alexandersomosi/freegpt.git
35+
cd freegpt
36+
```
37+
38+
### Step 2: Set up the Backend
39+
```bash
40+
cd backend
41+
python -m venv venv
42+
# Windows: venv\Scripts\activate
43+
# Mac/Linux: source venv/bin/activate
44+
pip install -r requirements.txt
45+
python main.py
46+
```
47+
48+
### Step 3: Set up the Frontend
49+
```bash
50+
# In a new terminal
51+
npm install
52+
npm run dev
53+
```
9754

9855
---
9956

100-
### Step 4: Use the App!
101-
102-
1. Open your web browser (Chrome, Edge, etc.).
103-
2. Go to address: **[http://localhost:5173](http://localhost:5173)**
104-
3. **Enter your API Key:**
105-
* Click the model name (top left corner, e.g., "Gemini 3 Pro").
106-
* Enter your **Google API Key** (or OpenAI/OpenRouter key).
107-
* *Don't have a key?* Get a free one here: [Google AI Studio](https://aistudio.google.com/)
108-
4. **Chat away!** Drag and drop files to ask questions about them.
109-
110-
---
111-
112-
## ❓ Troubleshooting
113-
114-
* **"Python not found":** Make sure you checked "Add Python to PATH" during installation.
115-
* **"npm is not recognized":** Restart your computer after installing Node.js.
116-
* **"API Key Invalid":** Double check you pasted the key correctly in the settings menu.
57+
## 🛠️ Build your own EXE
58+
If you want to create your own executable:
59+
1. Run `python build_executable.py` in the root directory.
60+
2. The result will be in the `dist/` folder.
11761

11862
## 📝 License
119-
[MIT](LICENSE) - Free to use and modify.
63+
[MIT](LICENSE) - Free to use and modify.

0 commit comments

Comments
 (0)