Skip to content

It is a chatbot powered by OpenAI, Langchain, ChromeDB, and Google APIs to educate students about TOBB University of Economics and Technology.

License

Notifications You must be signed in to change notification settings

TOBB-ETU-CS-Community/TOBB-GPT

Repository files navigation


Sourcery Poetry GPL v3 black isort


TOBB-GPT

It is a chatbot powered by OpenAI, Langchain, ChromeDB, and Google APIs to educate students about TOBB University of Economics and Technology.

WebApp link

Table of Contents

Prerequisites

Before setting up the project, ensure that you have the following prerequisites installed on your machine:

Installation

  1. Clone the project repository:
git clone https://github.com/TOBB-ETU-CS-Community/TOBB-GPT.git
  1. Navigate to the project directory:
cd tobb_gpt
  1. Install project dependencies using Poetry:
poetry install

This command will create a virtual environment and install all the necessary dependencies specified in the pyproject.toml file.

Usage

  1. Activate the virtual environment created by Poetry:
poetry shell
  1. Run the project:
streamlit run "tobb_gpt/app.py"

Contributing

If you would like to contribute to this project, follow the guidelines below:

  1. Fork the repository and clone it locally.

  2. Create a new branch for your feature or bug fix:

    git checkout -b feature/your-feature
    
  3. Make your changes and commit them with descriptive commit messages.

  4. Push your changes to your forked repository:

    git push origin feature/your-feature
    
  5. Open a pull request in the original repository, describing your changes in detail.

License

GPL v3