Welcome to paperyard's documentation!

What is paperyard

It is a tool which takes a scanned document, turns it into a searchable PDF documents and builds up a meaningful name based on the content of the document.

What does it consist of

Since paperyard uses multiple existing tools and would be difficult to set up itself, we utilize docker to combine all tooling.

Most of the code is written in PHP.

Quick start

  • Install docker

  • Docker is a tool that can package an application and its dependencies in a virtual container that can run on any Linux server. This helps enable flexibility and portability on where the application can run, whether on premises, public cloud, private cloud, bare metal, etc. LinuxMag *

  • docker-compose up -d
  • the source code can be found at: Github
  • The code documentation (doxygen) can be found at: Github

Authors

License

See here