Skip to content

Commit 813a643

Browse files
committed
docs: update README with virtual environment setup instructions
- Add instructions to README on how to set up virtual environment and run the application
1 parent 9686047 commit 813a643

File tree

1 file changed

+44
-2
lines changed

1 file changed

+44
-2
lines changed

README.md

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,47 @@
1+
# ChatGPT Clone
12
feel free to improve the code / suggest improvements
23

3-
run it: `python3 run.py`
4-
54
<img width="1470" alt="image" src="https://user-images.githubusercontent.com/98614666/232768610-fdeada85-3d21-4cf9-915e-a0ec9f3b7a9f.png">
5+
6+
7+
## Getting Started
8+
To get started with this project, you'll need to clone the repository and set up a virtual environment. This will allow you to install the required dependencies without affecting your system-wide Python installation.
9+
10+
### Prequisites
11+
Before you can set up a virtual environment, you'll need to have Python installed on your system. You can download Python from the official website: https://www.python.org/downloads/
12+
13+
### Cloning the Repository
14+
Run the following command to clone the repository:
15+
```
16+
git clone https://github.com/xtekky/chatgpt-clone.git
17+
```
18+
19+
### Setting up a Virtual Environment
20+
To set up a virtual environment, follow these steps:
21+
22+
1. Navigate to the root directory of your project.
23+
```
24+
cd chatgpt-clone
25+
```
26+
2. Run the following command to create a new virtual environment:
27+
```
28+
python -m venv venv
29+
```
30+
3. Activate the virtual environment by running the following command:
31+
```
32+
source venv/bin/activate
33+
```
34+
If you're on Windows, the command will be slightly different:
35+
```
36+
venv\Scripts\activate
37+
```
38+
4. Install the required dependencies by running the following command:
39+
```
40+
pip install -r requirements.txt
41+
```
42+
43+
### Running the Application
44+
To run the application, make sure the virtual environment is active and run the following command:
45+
```
46+
python run.py
47+
```

0 commit comments

Comments
 (0)