Skip to content

Brisbane (aka DirectoryGPT) -- A new way to interact with your filesystem

Notifications You must be signed in to change notification settings

magikarp01/BrisbaneGPT

Repository files navigation

Brisbane (aka DirectoryGPT) -- A new way to interact with your filesystem.

If your files could talk, what would they say? Ask your old code to explain itself, your CS project to tell you its requirements, or a folder full of textbooks to summarize themselves—with Brisbane.

Brisbane is a file search engine that allows you to chat with your files using an interactive interface. Made for Bitcamp 2023 at UMD.

Usage instructions

Distributable Image coming soon! Fow now, follow these instructions to reproduce the desktop application locally.

Set up environment:

Make sure you have npm, python and anaconda installed!

  • Clone the repository
  • Create a new conda environment conda create -n directorygpt python=3.8
  • Activate the conda environment conda activate directorygpt
  • Install requirements pip install -r requirements.txt
  • Install node packages in /frontend directory: npm i
  • Set up a GPT-3.5 OpenAI API key, store it in a file named .env as OPENAI_API_KEY="INSERT-KEY-HERE"

Set up application:

  • On a terminal, run python backend/app.py
  • On a separate terminal, change directory to /frontend and run npm start

Flow of Information

Brisbane Flowchart

Example Usage: Compiling housing information from many sources

image

Example Usage: Interpreting financial information from many reports

image

TODO

  • Create executable
  • Allow for collaboration in folders
  • Google Drive/OneDrive integration

About

Brisbane (aka DirectoryGPT) -- A new way to interact with your filesystem

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •