Skip to content

Latest commit

 

History

History
63 lines (42 loc) · 2.05 KB

README.md

File metadata and controls

63 lines (42 loc) · 2.05 KB
Raw

CompanianAI

This project's demo will be unable to generate prompts!

Reason: The OPEN AI API Key I was using has been shut down on my account due to exceeding my current quota, and will not generate any more prompts, however this project will work just fine when using locally or using your own API key

  • You will get FUNCTION_INVOCATION_TIMEOUT error when chatting with the companian (If you have any official OPEN AI key, please send a PR, It will be greatly appreciated 🙏)

CompanianAI is an AI companion web application built with Next.js. It leverages the power of artificial intelligence to provide a unique, interactive experience for users.

Features

  • Interactive AI: Engage in meaningful conversations with our AI.
  • Personalized Experience: The AI learns from your interactions to provide a personalized experience.
  • Real-time Interaction: Enjoy seamless, real-time interaction with the AI.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

  • Node.js
  • npm

Installation

  1. Clone the repo 
    git clone https://github.com/a1x5h04/CompanianAI.git
  2. Install NPM packages 
    npm install
  3. Start the development server 
    npm run dev

Usage

Visit localhost:3000 in your browser to start interacting with the AI.

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.

  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 for more information.

Acknowledgements

  • Next.js
  • OpenAI
  • And all the open-source community who greatly inspire us to learn and create.