{"id":18832590,"url":"https://github.com/jiisanda/docflow","last_synced_at":"2025-04-05T11:07:23.594Z","repository":{"id":195099541,"uuid":"671000997","full_name":"jiisanda/docflow","owner":"jiisanda","description":"DocFlow is a powerful Document Management API designed to streamline document handling, including seamless uploading, downloading, organization, versioning, sharing, and more.","archived":false,"fork":false,"pushed_at":"2024-12-27T18:02:00.000Z","size":1559,"stargazers_count":139,"open_issues_count":12,"forks_count":15,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-29T10:05:19.104Z","etag":null,"topics":["access-control-list","api","archiving","docker","docker-compose","document-management","document-management-system","document-sharing","ec2","fastapi","jwt-authentication","nginx","postgresql","pydantic","rest","s3","versioning"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jiisanda.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-26T10:08:29.000Z","updated_at":"2025-03-12T16:13:53.000Z","dependencies_parsed_at":"2023-11-01T11:29:03.211Z","dependency_job_id":"bb3c8d23-76da-4abf-ae38-95fd05c9f44d","html_url":"https://github.com/jiisanda/docflow","commit_stats":null,"previous_names":["jiisanda/docflow"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jiisanda%2Fdocflow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jiisanda%2Fdocflow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jiisanda%2Fdocflow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jiisanda%2Fdocflow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jiisanda","download_url":"https://codeload.github.com/jiisanda/docflow/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247325693,"owners_count":20920714,"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":["access-control-list","api","archiving","docker","docker-compose","document-management","document-management-system","document-sharing","ec2","fastapi","jwt-authentication","nginx","postgresql","pydantic","rest","s3","versioning"],"created_at":"2024-11-08T01:58:18.919Z","updated_at":"2025-04-05T11:07:23.574Z","avatar_url":"https://github.com/jiisanda.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DocFlow - Document Management API\n\n\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"app/docs/github-banner.png\"\u003e\u003cbr\u003e\n\u003c/div\u003e\n\n![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge\u0026logo=python\u0026logoColor=ffdd54)\n![FastAPI](https://img.shields.io/badge/FastAPI-005571?style=for-the-badge\u0026logo=fastapi)\n![Postgres](https://img.shields.io/badge/postgres-%23316192.svg?style=for-the-badge\u0026logo=postgresql\u0026logoColor=white)\n![AWS](https://img.shields.io/badge/AWS-%23FF9900.svg?style=for-the-badge\u0026logo=amazon-aws\u0026logoColor=white)\n![JWT](https://img.shields.io/badge/JWT-black?style=for-the-badge\u0026logo=JSON%20web%20tokens)\n![Swagger](https://img.shields.io/badge/-Swagger-%23Clojure?style=for-the-badge\u0026logo=swagger\u0026logoColor=white)\n![Github Pages](https://img.shields.io/badge/github%20pages-121013?style=for-the-badge\u0026logo=github\u0026logoColor=white)\n![GMail](https://img.shields.io/badge/Gmail-D14836?style=for-the-badge\u0026logo=gmail\u0026logoColor=white)\n\nDocFlow is a powerful Document Management API designed to streamline document handling, including seamless uploading, downloading, organization, versioning, sharing, and more.\n\n## 😎 Upcoming Updates\n\n- 🟨 Document Interactions - Adding Comments and Tags\n- 🟨 Import documents from unread emails\n- 🟨 Video Preview\n- 🟨 Adding custom metadata fields to document\n- 🟨 2-factor authentication\n- 🟨 Storage quota per user? (Maybe to enable limit storage per user)\n- 🟨 Bulk file importer\n\n## 🚀 Key Features\n\n- 💡 Document Upload and Download\n- 💡 Organization and Searching\n- 💡 Versioning\n- 💡 Sharing\n- 💡 Authentication and Authorization\n- 💡 Access Control List\n- 💡 Deletion and Archiving\n- 💡 Document Preview\n- 💡 Send file via Email\n\n\n## 📖 API Documentation and Image\n\nExplore the [API Documentation](https://documenter.getpostman.com/view/20984268/2s9YRGxUcp) for detailed information on how to use DocFlow's features.\n\nDetails about features and commands can be found [here](app/docs).\n\nDownload docker image from [docker-hub](https://hub.docker.com/r/jiisanda/docflow).\n\nOr just run\n```commandline\ndocker pull jiisanda/docflow:1\n```\n\n## 🔸 Setup Docflow \n\nFollow the steps outlined in the [setup.md](app/docs/setup.md) file.\n\n## 🧩 Implementation Detail\n\n\n| Features                         | Implementation Detail                                            |\n|----------------------------------|------------------------------------------------------------------|\n| Upload                           | [Detail](https://github.com/jiisanda/docflow#-document-upload)   |\n| Download                         | [Detail](https://github.com/jiisanda/docflow#-document-download) |\n| Sharing                          | [Detail](https://github.com/jiisanda/docflow#-document-sharing)  |\n| Document Preview                 | [Detail](https://github.com/jiisanda/docflow#-document-preview)  |\n\n\n### 📤 Document Upload\n\nHere's how documents are uploaded in DocFlow:\n\n![upload-document](app/docs/imgs/document/document_upload.png)\n\nFor a detailed explanation, visit the [Document Upload Documentation](app/docs/features/upload.md).\n\n### 📥 Document Download\n\nHere's how a user can download a file in DocFlow.\n\n![download-document](app/docs/imgs/document/docflow_download.png)\n\nFor detailed explanation, visit the [Document Download Documentation](). \n\n### 📨 Document Sharing\n\nLearn how to share documents in DocFlow:\n\n![share-document](app/docs/imgs/sharing/document_sharing.png)\n\nFor detailed instructions, visit the [Document Sharing Documentation](app/docs/features/sharing.md).\n\n### 👀 Document Preview\n\nHere's how the preview of docs works in DocFlow.\n\n![preview-document](app/docs/imgs/document/document_preview.png)\n\nFor detailed instructions, visit the [Document Preview Documentation](app/docs/features/preview.md)\n\n## 📜 License\n\n[![Licence](https://img.shields.io/github/license/Ileriayo/markdown-badges?style=for-the-badge)](./LICENSE)\n\n## 📧 Contact Us\n\nFor any questions or support, please [contact](mailto:harshjaiswal2307@gmail.com).\n\nTest DocFlow to manage documents seamlessly!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjiisanda%2Fdocflow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjiisanda%2Fdocflow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjiisanda%2Fdocflow/lists"}