{"id":13588473,"url":"https://github.com/3Alan/DocsMind","last_synced_at":"2025-04-08T06:32:06.522Z","repository":{"id":154207073,"uuid":"617546318","full_name":"3Alan/DocsMind","owner":"3Alan","description":"🤖 DocsMind allows you to chat with your docs and summarize your docs, support pdf, md. ","archived":false,"fork":false,"pushed_at":"2023-05-14T16:41:52.000Z","size":38158,"stargazers_count":176,"open_issues_count":2,"forks_count":75,"subscribers_count":7,"default_branch":"main","last_synced_at":"2024-11-06T08:40:03.318Z","etag":null,"topics":["chatgpt","chatpaper","chatpdf","gpt","langchain","llama-index","markdown","pdf","pdfgpt","summarizer"],"latest_commit_sha":null,"homepage":"https://docs-mind.alanwang.site","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/3Alan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2023-03-22T16:00:26.000Z","updated_at":"2024-11-01T17:58:38.000Z","dependencies_parsed_at":"2023-07-20T10:31:40.125Z","dependency_job_id":null,"html_url":"https://github.com/3Alan/DocsMind","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3Alan%2FDocsMind","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3Alan%2FDocsMind/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3Alan%2FDocsMind/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3Alan%2FDocsMind/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/3Alan","download_url":"https://codeload.github.com/3Alan/DocsMind/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247792075,"owners_count":20996876,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chatgpt","chatpaper","chatpdf","gpt","langchain","llama-index","markdown","pdf","pdfgpt","summarizer"],"created_at":"2024-08-01T15:06:44.148Z","updated_at":"2025-04-08T06:32:02.895Z","avatar_url":"https://github.com/3Alan.png","language":"TypeScript","funding_links":["https://ko-fi.com/N4N1L5Y7V"],"categories":["TypeScript"],"sub_categories":[],"readme":"# DocsMind\n\nDocsMind is an open-source project that allows you to chat with your docs.\n\n![Stack](https://skillicons.dev/icons?i=vite,react,ts,tailwind,flask)\n\nIt is currently under development and there may be major changes at any time.\n\n## 🎬 Demo\n\n[Demo Site](https://docs-mind.alanwang.site/)\n\n\u003e **Warning**\n\u003e\n\u003e Due to the free plan of Railway only providing 500 hours per month, the Demo on the 21st day of each month will not be available. Please clone it locally for use at that time.\n\n## 🌟 Features\n\n- 🤖 Ask a question with your docs\n- 📝 Summarize docs\n- 🖍️ Highlight source\n- 📤 Upload docs .pdf,.md(best support)\n- 💾 Data saved locally\n- 💰 Token usage tracker\n- 🐳 Dockerize\n\n## 🚀 Road Map\n\n- [ ] Chat mode\n- [ ] Dark mode\n- [ ] / command (/fetch /summarize)\n- [ ] Reduce the size of the server image.\n- [ ] Support for more docs formats: txt...\n- [ ] Download docs from the internet\n- [ ] Markdown-formatted message\n- [ ] i18n\n- [ ] Desktop application\n\nIf you find this project helpful, please consider giving it a star 🌟\n\n## 💻 Environment Variables\n\n| Name                 | Description                            | Optional |\n| -------------------- | -------------------------------------- | -------- |\n| OPENAI_PROXY         | will replace https://api.openai.com/v1 | ✅       |\n| VITE_SERVICES_URL    | backend url for frontend code          | ✅       |\n| VITE_DISABLED_UPLOAD | DISABLED_UPLOAD                        | ✅       |\n\n## ❓ FAQ\n\nThis project includes both frontend (/client) and backend (/server) code. The frontend code is used to display the UI, while the backend code provides services to the UI.\n\n### How to deploy?\n\n[More details](https://github.com/3Alan/DocsMind/blob/main/Deployment.md)\n\n### How to run?\n\n\u003e **Warning**\n\u003e\n\u003e Please check if you can access OpenAI in your region, you can refer to the [issue](https://github.com/3Alan/DocsMind/issues/3#issuecomment-1511470063) for more information.\n\n1. Create .env\n\nCreate a `.env` file and copy the contents of `.env.example` to modify it.\n\n2. Run App\n\n```bash\ndocker-compose up -d\n```\n\nPlease add `--build` to rebuild the image after each code update.\n\n```bash\ndocker-compose up -d --build\n```\n\nnow you can access the app at `http://localhost:8081`\n\nAll data will be saved in the `./data` directory.\n\n### Local Development\n\n\u003cdetails\u003e\n  \u003csummary\u003eDetail\u003c/summary\u003e\n\n#### Create .env\n\nCreate a `.env` file and copy the contents of `.env.example` to modify it.\n\n#### Run Frontend UI\n\n1. Install dependencies\n\n```\nyarn\n```\n\n2. Run app\n\n```\nyarn dev\n```\n\n#### Run Backend Services\n\nyou need a python environment\n\n1. Create virtual environment\n\n```\ncd server\npython -m venv .venv\n```\n\n2. Active virtual environment\n\nwindows\n\n```\n.venv\\Scripts\\activate\n```\n\nmac\n\n```\n. .venv/bin/activate\n```\n\n3. Install dependencies\n\n```\npip install -r requirements.txt\n```\n\n4. Run Services\n\n```\nflask run --reload --port=8080\n```\n\n\u003c/details\u003e\n\n## 📝 License\n\n[AGPL-3.0 License](https://github.com/3Alan/DocsMind/blob/main/LICENSE)\n\n## ☕ Buy me a coffee\n\n[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/N4N1L5Y7V)\n\n\u003cdetails\u003e\n  \u003csummary\u003eAlipay and Wechat\u003c/summary\u003e\n  \u003cimg height=\"300\" src=\"https://raw.githubusercontent.com/3Alan/images/master/img/%E5%BE%AE%E4%BF%A1%E6%94%AF%E4%BB%98%E5%AE%9D%E4%BA%8C%E5%90%88%E4%B8%80%E6%94%B6%E6%AC%BE%E7%A0%81.jpg\" /\u003e\n\u003c/details\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3Alan%2FDocsMind","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F3Alan%2FDocsMind","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3Alan%2FDocsMind/lists"}