annias / SolidGPT

Chat everything with your code repository, ask repository level code questions, and discuss your requirements. AI Scan and learning your code repository, provide you code repository level answer🧱 🧱

🧱 SolidGPT-Technology Business Boosting Framework

🚀 What’s this

Chat everything with your code repository, ask repository level code questions, and discuss your requirements. AI scans and learns from your code to seek coding advice, develop coding plans, and generate a product requirement documents using the information in the repository.

Chat with Your Code Repository (Beta) Published Chat with everything with your code repository, ask repository level code questions, and discuss your requirements.

🔥🔥 Click to try official host SolidGPT

If you like our work, please give us a 🌟 star. Your support serves as a great encouragement for us. Thank you! 😊

🏁 Quick Start

🧱 Prerequisite

• python3.8 or above
• OpenAI api key
• Install npm

🔧 Setup

git clone https://github.com/AI-Citizen/SolidGPT.git
cd SolidGPT 
pip3 install -r requirements.txt #installing the env

• Set the project root folder as python path

  • Linux/Mac

    export PYTHONPATH=$PYTHONPATH:$(git rev-parse --show-toplevel)/

  • Windows

    Replace path\to\directory with the path of the project root directory

    set PYTHONPATH=path\to\directory

• Start Server

  cd into the project root folder(SolidGPT)

  • Linux/Mac/WSL2

    sh StartServer.sh

  • Windows

    Install the WSL2 and start the server from WSL2

    wsl --install
    wsl2
    sh StartServer.sh

    Or install directly on Windows [Not Recommended]

    Note: redis server needs to be installed before running below commands: https://github.com/microsoftarchive/redis/releases

    uvicorn solidgpt.src.api.api:app --reload
    
    celery -A solidgpt.src.api.celery_tasks worker --loglevel=info -P eventlet
    

  • Docker

    docker buildx build -t solidgptlocalhost .
    docker run -p 8000:8000 solidgptlocalhost

• Start UI portal

  • You'll need to install npm, and we recommend using version 9.8.1 or higher.

    # From the project root folder
    cd solidportal/panel  
    npm i && npm start

🏠 Introduction

• SolidGPT first learns from your repository in the Onboard Project phase.

• After this, choose Generate PRD or Get Tech Solution for customized solutions based on the onboarded project.

📖 Onboarding your project

1. Choose Onboard Project from the top left dropdown.
2. Enter your OpenAI API key.
3. Upload your project folder.（All files will be save in your localstorage SolidGPT/localstorage/...）
4. ❗️Note: After completing the Onboard Project, an Onboard ID will be generated. If you remain in the same browser session, it will be automatically applied to subsequent actions. Alternatively, you can save it and manually input it in the future to bypass onboarding.

🧮 Get Technical Solution

1. Choose Get Tech Solution from the top left dropdown.
2. Enter your OpenAI API key.
3. Input your problem/Requirement.

Note: We currently support Python, JavaScript, and TypeScript projects. Support for more languages is on the way.

📁 Generate Product Requirement Document

1. Choose Generate RPD from the top left dropdown.
2. Input your requirement (suggest short and clear)
3. Input additional info or your project, SolidGPT will both use a summary from the repository and additional info you provide (optional)

📺 Demo(v0.2.5)

🖇️ Document

Explore SolidGPT

Solid Portal

Solid GPT Infrastructure

Deeply Customize Agent Skill

Embedding with private data

Fine-tuning with GPT3.5

Fine-tuning with Llama2

Contact

If you have any questions or feedback about our project, please don't hesitate to reach out to us. We greatly appreciate your suggestions!

• Email: [e-mail]
• GitHub Issues: For more technical inquiries, you can also create a new issue in our GitHub repository. We will respond to all questions within 2-3 business days.