https://github.com/jiisanda/docflow

DocFlow is a powerful Document Management API designed to streamline document handling, including seamless uploading, downloading, organization, versioning, sharing, and more.
https://github.com/jiisanda/docflow

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

Last synced: 22 days ago
JSON representation

DocFlow is a powerful Document Management API designed to streamline document handling, including seamless uploading, downloading, organization, versioning, sharing, and more.

• Host: GitHub
• URL: https://github.com/jiisanda/docflow
• Owner: jiisanda
• License: mit
• Created: 2023-07-26T10:08:29.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-12-27T18:02:00.000Z (4 months ago)
• Last Synced: 2025-03-29T10:05:19.104Z (29 days ago)
• 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
• Language: Python
• Homepage:
• Size: 1.49 MB
• Stars: 139
• Watchers: 5
• Forks: 15
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# DocFlow - Document Management API



    




![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)

![FastAPI](https://img.shields.io/badge/FastAPI-005571?style=for-the-badge&logo=fastapi)

![Postgres](https://img.shields.io/badge/postgres-%23316192.svg?style=for-the-badge&logo=postgresql&logoColor=white)

![AWS](https://img.shields.io/badge/AWS-%23FF9900.svg?style=for-the-badge&logo=amazon-aws&logoColor=white)

![JWT](https://img.shields.io/badge/JWT-black?style=for-the-badge&logo=JSON%20web%20tokens)

![Swagger](https://img.shields.io/badge/-Swagger-%23Clojure?style=for-the-badge&logo=swagger&logoColor=white)

![Github Pages](https://img.shields.io/badge/github%20pages-121013?style=for-the-badge&logo=github&logoColor=white)

![GMail](https://img.shields.io/badge/Gmail-D14836?style=for-the-badge&logo=gmail&logoColor=white)

DocFlow is a powerful Document Management API designed to streamline document handling, including seamless uploading, downloading, organization, versioning, sharing, and more.

## 😎 Upcoming Updates

- 🟨 Document Interactions - Adding Comments and Tags

- 🟨 Import documents from unread emails

- 🟨 Video Preview

- 🟨 Adding custom metadata fields to document

- 🟨 2-factor authentication

- 🟨 Storage quota per user? (Maybe to enable limit storage per user)

- 🟨 Bulk file importer

## 🚀 Key Features

- 💡 Document Upload and Download

- 💡 Organization and Searching

- 💡 Versioning

- 💡 Sharing

- 💡 Authentication and Authorization

- 💡 Access Control List

- 💡 Deletion and Archiving

- 💡 Document Preview

- 💡 Send file via Email

## 📖 API Documentation and Image

Explore the [API Documentation](https://documenter.getpostman.com/view/20984268/2s9YRGxUcp) for detailed information on how to use DocFlow's features.

Details about features and commands can be found [here](app/docs).

Download docker image from [docker-hub](https://hub.docker.com/r/jiisanda/docflow).

Or just run

```commandline

docker pull jiisanda/docflow:1

```

## 🔸 Setup Docflow 

Follow the steps outlined in the [setup.md](app/docs/setup.md) file.

## 🧩 Implementation Detail

| Features                         | Implementation Detail                                            |

|----------------------------------|------------------------------------------------------------------|

| Upload                           | [Detail](https://github.com/jiisanda/docflow#-document-upload)   |

| Download                         | [Detail](https://github.com/jiisanda/docflow#-document-download) |

| Sharing                          | [Detail](https://github.com/jiisanda/docflow#-document-sharing)  |

| Document Preview                 | [Detail](https://github.com/jiisanda/docflow#-document-preview)  |

### 📤 Document Upload

Here's how documents are uploaded in DocFlow:

![upload-document](app/docs/imgs/document/document_upload.png)

For a detailed explanation, visit the [Document Upload Documentation](app/docs/features/upload.md).

### 📥 Document Download

Here's how a user can download a file in DocFlow.

![download-document](app/docs/imgs/document/docflow_download.png)

For detailed explanation, visit the [Document Download Documentation](). 

### 📨 Document Sharing

Learn how to share documents in DocFlow:

![share-document](app/docs/imgs/sharing/document_sharing.png)

For detailed instructions, visit the [Document Sharing Documentation](app/docs/features/sharing.md).

### 👀 Document Preview

Here's how the preview of docs works in DocFlow.

![preview-document](app/docs/imgs/document/document_preview.png)

For detailed instructions, visit the [Document Preview Documentation](app/docs/features/preview.md)

## 📜 License

[![Licence](https://img.shields.io/github/license/Ileriayo/markdown-badges?style=for-the-badge)](./LICENSE)

## 📧 Contact Us

For any questions or support, please [contact](mailto:[email protected]).

Test DocFlow to manage documents seamlessly!