Skip to content

Commit 95f8ff5

Browse files
author
followDev
committed
readme update for installation of app
1 parent e37864d commit 95f8ff5

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

README.md

+44
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,48 @@
11
# ChatGPT clone using OpenAI API
2+
This clone is made with React and Node and uses OpenAI API.
3+
4+
- get your api key from https://openai.com/api/
5+
6+
## Prerequisites
7+
Make sure you have installed all of the following prerequisites on your development machine:
8+
* Git - [Download & Install Git](https://git-scm.com/downloads). OSX and Linux machines typically have this already installed.
9+
* Node.js - [Download & Install Node.js](https://nodejs.org/en/download/) and the npm package manager. If you encounter any problems, you can also use this [GitHub Gist](https://gist.github.com/isaacs/579814) to install Node.js.
10+
11+
## Environment variables setup example
12+
```
13+
OPENAI_API_KEY = YOU_API_KEY_HERE
14+
MONGO_URI = mongodb://0.0.0.0:27017/chatGPT
15+
```
16+
17+
18+
## Cloning The GitHub Repository
19+
The recommended way to get ChatGPT clone is to use git to directly clone the repository:
20+
21+
```bash
22+
$ git clone https://github.com/nisabmohd/ChatGPT.git
23+
```
24+
25+
## Running Your Application
26+
27+
open terminal/bash in this repo and enter below commands to start the application
28+
29+
→ To start the server
30+
```bash
31+
$ node server
32+
```
33+
34+
→ To start the client app
35+
```bash
36+
$ cd client
37+
$ npm run dev
38+
```
39+
40+
41+
42+
* Your client application should run on port 3000 with the *development* environment configuration, so in your browser just go to [http://localhost:5173](http://localhost:5173)
43+
44+
* Your server application should run on port 8000, so in your browser just go to [http://localhost:8000](http://localhost:3000)
45+
246

347
<img width="100%" src="img/home.png" />
448
<img width="100%" src="img/chat.png" />

0 commit comments

Comments
 (0)