Help you generate Product Requirement Document and Code Solution base on your private code repository.

V0.2.5: Enable users to host the whole features of SolidGPT service locally while ensuring data privacy.

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

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

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

• Set 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 to 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

  • 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

• 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.

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.

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.

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 use both summary from repository and additional info you provided (optinoal)

## 🖇️ Document
[Explore SolidGPT](https://github.com/AI-Citizen/SolidGPT/blob/main/docs/READMEv1.md)

[Solid Portal](https://github.com/AI-Citizen/SolidGPT/blob/main/docs/solidportal.md)

[Solid GPT Infrastructure](https://github.com/AI-Citizen/SolidGPT/blob/main/docs/infrastructure.md)

[Deeply Customize Agent Skill](https://github.com/AI-Citizen/SolidGPT/blob/main/docs/customagentskill.md)

[Embedding with private data](https://github.com/AI-Citizen/SolidGPT/blob/main/docs/embeddingprivatedata.md)

[Fine-tuning with GPT3.5](https://github.com/AI-Citizen/SolidGPT/blob/main/docs/gptfinetuning.md)

[Fine-tuning with Llama2](https://github.com/AI-Citizen/SolidGPT/blob/main/docs/llama2finetuning.md)

## 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: [email protected]
- GitHub Issues: For more technical inquiries, you can also create a new issue in our [GitHub repository](https://github.com/AI-Citizen/SolidGPT/issues).
We will respond to all questions within 2-3 business days.