From 7da3618e0c482be0baf8ecc0894cde1fa8eabd8d Mon Sep 17 00:00:00 2001 From: Alex Date: Wed, 18 Jun 2025 22:25:47 +0100 Subject: [PATCH] Update README.md --- README.md | 157 ++---------------------------------------------------- 1 file changed, 4 insertions(+), 153 deletions(-) diff --git a/README.md b/README.md index bc4113ee..955ae810 100644 --- a/README.md +++ b/README.md @@ -1,158 +1,9 @@ -

- DocsGPT πŸ¦– -

+# MDA qa POC -

- Open-Source RAG Assistant -

- -

- DocsGPT is an open-source genAI tool that helps users get reliable answers from any knowledge source, while avoiding hallucinations. It enables quick and reliable information retrieval, with tooling and agentic system capability built in. -

- -
- - ![link to main GitHub showing Stars number](https://img.shields.io/github/stars/arc53/docsgpt?style=social) - ![link to main GitHub showing Forks number](https://img.shields.io/github/forks/arc53/docsgpt?style=social) - ![link to license file](https://img.shields.io/github/license/arc53/docsgpt) - - ![link to discord](https://img.shields.io/discord/1070046503302877216) - ![X (formerly Twitter) URL](https://img.shields.io/twitter/follow/docsgptai) - - ⚑️ Quickstart β€’ ☁️ Cloud Version β€’ πŸ’¬ Discord -
- πŸ“– Documentation β€’ πŸ‘« Contribute β€’ πŸ—ž Blog -
- -
-
-video-example-of-docs-gpt -
-

- Key Features: -

- - -## Roadmap - -- [x] Full GoogleAI compatibility (Jan 2025) -- [x] Add tools (Jan 2025) -- [x] Manually updating chunks in the app UI (Feb 2025) -- [x] Devcontainer for easy development (Feb 2025) -- [x] ReACT agent (March 2025) -- [x] Chatbots menu re-design to handle tools, agent types, and more (April 2025) -- [x] New input box in the conversation menu (April 2025) -- [x] Add triggerable actions / tools (webhook) (April 2025) -- [ ] Anthropic Tool compatibility (May 2025) -- [ ] Add OAuth 2.0 authentication for tools and sources -- [ ] Agent scheduling - -You can find our full roadmap [here](https://github.com/orgs/arc53/projects/2). Please don't hesitate to contribute or create issues, it helps us improve DocsGPT! - -### Production Support / Help for Companies: - -We're eager to provide personalized assistance when deploying your DocsGPT to a live environment. - -[Get a Demo :wave:](https://www.docsgpt.cloud/contact)⁠ - -[Send Email :email:](mailto:support@docsgpt.cloud?subject=DocsGPT%20support%2Fsolutions) - -## Join the Lighthouse Program 🌟 - -Calling all developers and GenAI innovators! The **DocsGPT Lighthouse Program** connects technical leaders actively deploying or extending DocsGPT in real-world scenarios. Collaborate directly with our team to shape the roadmap, access priority support, and build enterprise-ready solutions with exclusive community insights. - -[Learn More & Apply β†’](https://docs.google.com/forms/d/1KAADiJinUJ8EMQyfTXUIGyFbqINNClNR3jBNWq7DgTE) +[To run dev env](https://docs.docsgpt.cloud/Deploying/Development-Environment) -## QuickStart - -> [!Note] -> Make sure you have [Docker](https://docs.docker.com/engine/install/) installed - -A more detailed [Quickstart](https://docs.docsgpt.cloud/quickstart) is available in our documentation - -1. **Clone the repository:** - - ```bash - git clone https://github.com/arc53/DocsGPT.git - cd DocsGPT - ``` - -**For macOS and Linux:** - -2. **Run the setup script:** - - ```bash - ./setup.sh - ``` - -**For Windows:** - -2. **Run the PowerShell setup script:** - - ```powershell - PowerShell -ExecutionPolicy Bypass -File .\setup.ps1 - ``` - -Either script will guide you through setting up DocsGPT. Four options available: using the public API, running locally, connecting to a local inference engine, or using a cloud API provider. Scripts will automatically configure your `.env` file and handle necessary downloads and installations based on your chosen option. - -**Navigate to http://localhost:5173/** - -To stop DocsGPT, open a terminal in the `DocsGPT` directory and run: - -```bash -docker compose -f deployment/docker-compose.yaml down -``` -(or use the specific `docker compose down` command shown after running the setup script). - -> [!Note] -> For development environment setup instructions, please refer to the [Development Environment Guide](https://docs.docsgpt.cloud/Deploying/Development-Environment). - -## Contributing - -Please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file for information about how to get involved. We welcome issues, questions, and pull requests. - -## Architecture - -![Architecture chart](https://github.com/user-attachments/assets/fc6a7841-ddfc-45e6-b5a0-d05fe648cbe2) - -## Project Structure - -- Application - Flask app (main application). - -- Extensions - Extensions, like react widget or discord bot. - -- Frontend - Frontend uses Vite and React. - -- Scripts - Miscellaneous scripts. - -## Code Of Conduct - -We as members, contributors, and leaders, pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. Please refer to the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) file for more information about contributing. +[To run docker env](https://docs.docsgpt.cloud/Deploying/Docker-Deploying) -## Many Thanks To Our Contributors⚑ - - - Contributors - - -## License - -The source code license is [MIT](https://opensource.org/license/mit/), as described in the [LICENSE](LICENSE) file. - -

This project is supported by:

-

- - - -

+Env vars to make it work: \ No newline at end of file