Skip to content

Latest commit

 

History

History
72 lines (56 loc) · 3.72 KB

README.md

File metadata and controls

72 lines (56 loc) · 3.72 KB
Raw

🧱 SolidGPT

🚀 What's this

SolidGPT is a AI searching assistant for developer that helps code and workspace semantic search

🔥🔥🔥 Try SolidGPT VSCode Extension from the VSCode Marketplace

Appreciate Star 🌟 us on our SolidGPT Github

Try SolidGPT VSCode Extension

  1. Install SolidGPT VSCode Extension from the VSCode Marketplace

🏁 Quick Start

Highly recommend to try SolidGPT VSCode Extension from the VSCode Marketplace.

Or you can follow the steps below to build from source.

📦 Build From Source

  1. Pull the latest version of the SolidGPT from the GitHub repository.
  2. Pip install the requirements.txt file under the SolidGPT root directory.
pip install -r requirements.txt
  1. Open terminal and run the following command to start the server.
python run_api.py
  1. Open terminal and run the following command to start the webapp.
cd solidportal
npm install
npm run dev

❗️❗️ Onborading your Codebase and Notion

  1. Click Settings button on the right bottom corner.
image

1. Setup Codebase

  1. Enter your OpenAI API key. Get OpenAI API Key
  2. Enter the full path of the folder you wish to onboard. Suggest onboard lower than 100 files, maximum support 500 files onboarding.
image

2. Setup Notion (Optional)

  1. Configure the Notion API by getting your Notion API secret from Notion API and entering it on the Settings page
  2. Give your integration page permissions. Details
  3. Get Notion Page ID and entering it on the Settings page
image image

3. Pick chat resources and start chat

🔥 Usecase

  • Talk to your codebase, save time hunting for the place to start a change or the right method to call.
  • Ask any questions about your codebase, get the answer in seconds.
  • Semantic search and summary in Notion, knows your project from documents and track the project sprint board and tickets.
  • Get questions answered from your codebase and Notion, no more context switching.

📖 Known Issue

  1. [Intel Chip Mac]: permission denied
    • Please run `cd ~/.vscode/extensions` and `chmod -R 777 aict.solidgpt*` in your terminal to allow the app to run.

📣 Feedback!!

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. We will respond to all questions within 2-3 business days.

Data Safety

  • SolidGPT will not collect any of users' data.
  • SolidGPT using OpenAI series model API, using SolidGPT indicates that you have read, understood, and agreed to adhere to all terms of use associated with the OpenAI GPT series model API.