GROUNDTRUTH

Description

GROUNDTRUTH is a DevTool that suggests automatic documentation changes as you develop your code. Using webhooks, GROUNDTRUTH can receive your code changes and suggest real-time documentation changes.

Table of Contents

1. Installation
2. Dependencies
3. Usage
4. Contributing

Installation

Step-by-step guide to install and run the project.

1. Clone the repository:

   git clone https://github.com/Hassanmushtaq524/groundtruth.git
   

2. Navigate to your project

   cd groundtruth
   

3. Navigate to your project

   cd groundtruth
   

4. Install required dependencies

   pip install -r requirements.txt
   

5. Setup backend/.env

   # Database configuration
   GROQ_API_KEY=<your_groq_key>
   OPENAI_API_KEY=<your_openai_key>
   
   

6. Setup ngrok: Login to ngrok and follow instructions

   ngrok HTTP <BACKEND_PORT>
   

Dependencies

List of dependencies:

1. reflex
2. chromadb
3. openai
4. groq
5. reflex>=0.6.0a
6. reflex-chakra
7. requests
8. json
9. fastapi
10. os
11. re
12. base64
13. dotenv
14. typing
15. httpx

Usage

Step-by-step guide to use and run the project.

1. Run reflex

   reflex run
   

Make sure reflex is set up to run. This will launch both your backend and your frontend.

Contributers

Hassan Mushtaq: Hassanmushtaq524 Joe Malatesta: Joe Malatesta Yashwanth Alluri: Yashwanth Alluri