Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ssk-14/gitdoc-ai
GitDoc is your ultimate GitHub Documentation Explorer! It's your trusty sidekick for navigating through the vast world of open-source projects, making code exploration and documentation retrieval a breeze. 🚀
https://github.com/ssk-14/gitdoc-ai
chatbot documentation embeddings langchain langsmith nemo-guardrails streamlit
Last synced: 27 days ago
JSON representation
GitDoc is your ultimate GitHub Documentation Explorer! It's your trusty sidekick for navigating through the vast world of open-source projects, making code exploration and documentation retrieval a breeze. 🚀
- Host: GitHub
- URL: https://github.com/ssk-14/gitdoc-ai
- Owner: SSK-14
- Created: 2023-09-15T16:02:33.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-04T13:23:49.000Z (over 1 year ago)
- Last Synced: 2024-11-05T11:00:09.606Z (2 months ago)
- Topics: chatbot, documentation, embeddings, langchain, langsmith, nemo-guardrails, streamlit
- Language: Python
- Homepage: https://gitdoc-ai.streamlit.app/
- Size: 17.9 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GitDoc AI 📚
> Created the GitDoc AI app to improve knowledge retrieval and support from documentation. Users can effortlessly engage with their chosen documentation or GitHub repositories through a Language Model (LLM).
## Demo
- [Demo video](https://github.com/SSK-14/GitDoc-AI/blob/main/assets/gitdoc-demo.mp4)
## Key Features 💡
- 📖 **Rich Documentation Access:** Instantly access project documentation, READMEs, code snippets, and more.
- 🌟 **Interactive Chat:** Engage with GitDoc for info, questions, and code insights.
- 🧠 **AI-Powered Insights:** Intelligent code tips with advanced Language Models.
- 🚀 **Boost Your Development:** Speed up coding, troubleshoot, and stay updated.
- 🌈 **User-Friendly Interface:** Enjoy a smooth coding experience.
Experience the future of GitHub documentation exploration with GitDoc - Where curiosity meets code! 🚀📚💬
## Requirements ✅
- Python 3.7 or above
- Langchain library
- Streamlit library
## To run the app ⚙️
#### Clone the repo
```
git clone https://github.com/SSK-14/Cloud-Guardian.git
```
#### If running for the first time,
1. Create virtual environment
```
pip3 install env
python3 -m venv env
source env/bin/activate
```
2. Install required libraries
```
pip3 install -r requirements.txt
```
#### Activate your virtual environment
```
source env/bin/activate
```
#### Run the Streamlit app
```
streamlit run 🏠_Home.py
```
## Resources 🔧
- [langchain](https://python.langchain.com/en/latest/index.html)
- [Streamlit](https://discuss.streamlit.io/)