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
-
-
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
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
-
-
-
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.
- Choose
Onboard Project
from the top left dropdown. - Enter your OpenAI API key.
- Upload your project folder.(All files will be save in your localstorage
SolidGPT/localstorage/...
) - ❗️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.
- Choose
Get Tech Solution
from the top left dropdown. - Enter your OpenAI API key.
- Input your problem/Requirement.
Note: We currently support Python, JavaScript, and TypeScript projects. Support for more languages is on the way.
- Choose
Generate RPD
from the top left dropdown. - input your requirement (suggest short and clear)
- input additional info or your project, SolidGPT will use both summary from repository and additional info you provided (optinoal)
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: aict@ai-citi.com
- 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.