Skip to content

webdevtut/catgpt

Repository files navigation

Issues MIT License LinkedIn


Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

CatGPT Screen Shot

Artificial intelligence chatbot created for self-learning and showcase purpose.

Features :

  • Auth0 authentication and responsive for multiple screens 😄

  • Open AI stream integration

  • Chat history with database storage

(back to top)

Built With

Following Frameworks are used to make this project

  • Next
  • Node
  • REACT
  • Mongodb
  • Tailwind
  • auth0
  • openai
  • fontawesome

(back to top)

Getting Started

To get a local copy up and running follow these steps.

Prerequisites

Install Node v14+

  • npm
    npm install npm@latest -g

Installation

  1. Clone the repo

    git clone https://github.com/webdevtut/catgpt.git
  2. Install NPM packages

    npm install
  3. Connect MongoDB URL

  4. Get Auth0 Keys here

  5. Get OpenAI API Keys here

  6. Get MongoDB Database URL here

  7. In base folder run the command

    npm run dev

(back to top)

Usage

Create an account on deployed website to see the example🤗.

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • Deployment on Vercel
  • Auth0 Integration And Responsive styling upgrade
  • 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 for a full list of proposed features (and known issues).

(back to top)

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

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - @tushar-web-dev - [email protected]

Project Link: https://catgpt-ai.vercel.app/

(back to top)

Acknowledgments

Useful links

(back to top)

Releases

No releases published

Packages

No packages published