Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/webdevtut/catgpt
chatgpt clone
https://github.com/webdevtut/catgpt
Last synced: about 1 month ago
JSON representation
chatgpt clone
- Host: GitHub
- URL: https://github.com/webdevtut/catgpt
- Owner: webdevtut
- License: mit
- Created: 2023-06-05T06:55:16.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-08-14T06:53:00.000Z (over 1 year ago)
- Last Synced: 2023-08-14T07:50:54.562Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://catgpt-ai.vercel.app/
- Size: 570 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
Table of Contents
## About The Project
[![CatGPT Screen Shot][product-screenshot]](https://catgpt-ai.vercel.app/)
Artificial intelligence chatbot created for self-learning and showcase purpose.
Features :
- Auth0 authentication and responsive for multiple screens :smile:
- Open AI stream integration
- Chat history with database storage
### Built With
Following Frameworks are used to make this project
- [![Next][Next.io]][Next-url]
- [![Node][Node.io]][Node-url]
- [![REACT][REACT.io]][REACT-url]
- [![Mongodb][Mongodb.io]][Mongodb-url]
- [![Tailwind][Tailwind.io]][Tailwind-url]
- [![auth0][auth0.io]][auth0-url]
- [![openai][openai.io]][openai-url]
- [![fontawesome][fontawesome.io]][fontawesome-url]
## Getting Started
To get a local copy up and running follow these steps.
### Prerequisites
Install Node v14+
- npm
```sh
npm install npm@latest -g
```
### Installation
1. Clone the repo
```sh
git clone https://github.com/webdevtut/catgpt.git
```
2. Install NPM packages
```sh
npm install
```
3. Connect MongoDB URL
4. Get Auth0 Keys _→ [here](https://auth0.com/)_
5. Get OpenAI API Keys _→ [here](https://openai.com/)_
6. Get MongoDB Database URL _→ [here](https://account.mongodb.com/account/register)_
7. In base folder run the command
```sh
npm run dev
```
## Usage
Create an account on deployed website to see the example🤗.
_For more examples, please refer to the [Documentation](https://catgpt-ai.vercel.app/)_
## Roadmap
- [x] Deployment on Vercel
- [x] Auth0 Integration And Responsive styling upgrade
- [x] Chat history implementation using react and mongodb
- [ ] Add Features for User Accessibility
- [ ] images from internet to be added in chat.
- [ ] Voice to text for asking questions to AI.
See the [open issues](https://github.com/webdevtut/catgpt/issues) for a full list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the MIT License. See `LICENSE.txt` for more information.
## Contact
Your Name - [@tushar-web-dev](https://linkedin.com/in/tushar-web-dev/) - [email protected]
Project Link: [https://catgpt-ai.vercel.app/](https://catgpt-ai.vercel.app/)
## Acknowledgments
Useful links
- [Alternative to Heroku for deployment](https://vercel.com/)
- [MongoDB Cheat Sheet](https://www.mongodb.com/developer/products/mongodb/cheat-sheet/)
- [React Starter](https://create-react-app.dev/)
- [Choose an Open Source License](https://choosealicense.com)
- [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet)
- [Img Shields](https://shields.io)
[issues-shield]: https://img.shields.io/github/issues/webdevtut/catgpt.svg?style=for-the-badge
[issues-url]: https://github.com/webdevtut/catgpt/issues
[license-shield]: https://img.shields.io/github/license/webdevtut/catgpt.svg?style=for-the-badge
[license-url]: https://github.com/webdevtut/catgpt/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/tushar-web-dev/
[product-screenshot]: screenshots/product_screenshot.jpg
[Tailwind.io]: https://img.shields.io/badge/Tailwind-06B6D4?style=for-the-badge&logo=tailwindcss&logoColor=white
[Tailwind-url]: https://tailwindcss.com/
[auth0.io]: https://img.shields.io/badge/Auth0-EB5424?style=for-the-badge&logo=auth0&logoColor=white
[auth0-url]: https://auth0.com/
[openai.io]: https://img.shields.io/badge/openai-412991?style=for-the-badge&logo=openai&logoColor=white
[openai-url]: https://openai.com/
[fontawesome.io]: https://img.shields.io/badge/fontawesome-528DD7?style=for-the-badge&logo=fontawesome&logoColor=white
[fontawesome-url]: https://fontawesome.com/
[Next.io]: https://img.shields.io/badge/Next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
[Next-url]: https://nextjs.org/
[Mongodb.io]: https://img.shields.io/badge/MONGODB-47A248?style=for-the-badge&logo=mongodb&logoColor=white
[Mongodb-url]: https://www.mongodb.com/
[Node.io]: https://img.shields.io/badge/Node.js-339933?style=for-the-badge&logo=nodedotjs&logoColor=white
[Node-url]: https://nodejs.org/
[REACT.io]: https://img.shields.io/badge/React-61DAFB?style=for-the-badge&logo=react&logoColor=white
[REACT-url]: https://react.dev/
