Skip to content

Commit 3b36c61

Browse files
committed
updated readme
1 parent 10c5c37 commit 3b36c61

File tree

1 file changed

+30
-23
lines changed

1 file changed

+30
-23
lines changed

README.md

+30-23
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,45 @@
1-
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
1+
# ChatGPT Clone
22

3-
## Getting Started
3+
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
44

5-
First, run the development server:
5+
ChatGPT Clone is a fully functional clone of ChatGPT, an AI-powered chatbot, built using Next.js and Tailwind CSS. It allows users to have interactive conversations with the chatbot, powered by the OpenAI GPT-3.5 language model.
66

7-
```bash
8-
npm run dev
9-
# or
10-
yarn dev
11-
# or
12-
pnpm dev
13-
```
7+
**Try it now:** https://chat-clone-gpt.vercel.app/
148

15-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
9+
🎥 **Watch the Demo Video**
1610

17-
You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.
11+
[![Demo Video](https://img.youtube.com/vi/your-video-id/maxresdefault.jpg)](https://www.youtube.com/watch?v=your-video-id)
1812

19-
[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`.
13+
## Technology Choices
2014

21-
The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
15+
ChatGPT Clone utilizes the following technologies:
2216

23-
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
17+
| Technology | Version |
18+
| ---------------- | ------- |
19+
| Next.js | 13.3.0 |
20+
| Tailwind CSS | 3.3.1 |
21+
| React | 18.2.0 |
22+
| TypeScript | 5.0.4 |
23+
| Axios | 1.3.5 |
24+
| dotenv | 16.0.3 |
25+
| OpenAI | 3.2.1 |
26+
| mixpanel-browser | 2.46.0 |
27+
| uuid | 9.0.0 |
2428

25-
## Learn More
29+
## Getting Started
2630

27-
To learn more about Next.js, take a look at the following resources:
31+
To get started with ChatGPT Clone, follow these steps:
2832

29-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
30-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
33+
1. Clone the repository: `git clone https://github.com/your-username/ChatGPT-Clone.git`
34+
2. Install the dependencies: `yarn`
35+
3. Set up your environment variables by creating a `.env` file and adding the necessary values.
36+
4. Run the development server: `yarn dev`
37+
5. Open [http://localhost:3000](http://localhost:3000) in your browser to see the application.
3138

32-
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
39+
## Contributing
3340

34-
## Deploy on Vercel
41+
Contributions are welcome! If you find ChatGPT Clone useful, consider starring the repository on GitHub.
3542

36-
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
43+
## License
3744

38-
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
45+
This project is open source and available under the [MIT License](https://opensource.org/licenses/MIT).

0 commit comments

Comments
 (0)