Skip to content

Jarrettluo/all-docs

 
 

Repository files navigation

Contributors Forks Stargazers Issues MIT License


Logo

All Docs

Document sharing and storage system with full-text search support.

ABOUT THE PROJECT

In small teams, there is often a large number of collaborative documents. For example, we place various types of documents in cloud storage, SVN, and other software, but there is a problem with the inability to quickly search for content within the documents. Therefore, we have developed a dedicated knowledge base for storing documents such as PPT, Word, PNG, etc., which supports private deployment and retrieval.

Experience URL:https://alldocs.tech

administrator account:admin123, administrator password: admin123

ARCHITECTURE

Multi-Module Architecture

all-docs (父工程)
├── all-docs-common      # 公共模块:工具类、通用响应、异常处理
├── all-docs-domain       # 领域模块:实体、值对象、领域服务
├── all-docs-infrastructure # 基础设施模块:MongoDB、Redis、Elasticsearch、MinIO 适配
├── all-docs-application  # 应用模块:业务编排、DTO、Service
├── all-docs-api          # API 模块:Controller、配置
└── all-docs-bootstrap    # 启动模块:应用入口

Technology Stack

组件 说明
MinIO S3 协议对象存储,替代 GridFS 存储文件(规划中)
MongoDB 主数据库,存储文档元数据和用户信息
Elasticsearch 全文搜索引擎,支持中文分词检索
Redis 缓存层,提升热点数据访问性能

Development Requirements

  • Java: 17+
  • Maven: 3.8+
  • Node.js: 14+ (前端开发)
  • IDE: IntelliJ IDEA

Module Dependencies

bootstrap -> api -> application -> infrastructure -> domain -> common

QUICK START

test on ubuntu 18.04 wait me for centos, thank you.

‼️ 受dockerhub拉取镜像影响,此部署方法暂时失效!‼️

# clone project
git clone https://github.com/Jarrettluo/all-docs.git

# switch user to root
su root

# switch work directory
cd document-sharing-site && cd docker

# chmod
chmod +x auto.sh

# start shell script
sudo ./auto.sh

PREVIEW

homepage

homepage

docList

list of documents

searchPage

page of search

fileUpload

upload page

userPage

user's info page

Repository URL

frontend project: https://github.com/Jarrettluo/all-documents-vue.git

backend project: https://github.com/Jarrettluo/document-sharing-site.git

We choose MongoDB as the primary database to store documents and files.

Backend:SpringBoot + MongoDB + ES

Frontend:Vue + axios

PROJECT DEPLOYMENT

ROADMAP

  • Record the last page number read by the user 🌟
  • Revamp the search page style 🌟🌟
  • Allow users to bookmark documents 🌟
  • Support video files 🌟
  • Support permission management 🌟
  • Support file tree 🌟
  • Support Mobi files 🌟

read open issues

CONTRIBUTING

You can join our Wechat group if you are interested.

imGroup

If you have any requirements for customization or private deployment, please feel free to contact me.

(Please add me on WeChat and kindly mention 'All Docs' in the request.)

imGroup

  1. Fork This project
  2. create a branch (git checkout -b feature/AmazingFeature)
  3. commit you feature (git commit -m 'Add some AmazingFeature')
  4. push the commit (git push origin feature/AmazingFeature)
  5. open a pull request

CONTACT

Read LICENSE file。

CONTACT

Jarrett Luo - luojiarui2@163.com

If you find the project valuable, your support and appreciation are welcome!

imGroup

ACKNOWLEDGEMENTS

  • YOU

About

"All Docs" is a tool that enables online previewing, storage, and sharing of documents such as Word, Excel, PowerPoint, PDF, and images (Pic). It supports full-text search for all document information. “全文档”(All Docs),Word, Excel, PPT, PDF, Pic等文档在线预览、存储、共享的工具,并且支持全文搜索的所有的文档信息。demo账号密码:admin123

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors