swkom-paperless

This is the semester project for the Software Component Systems course at FH Technikum Wien, WS 2023.

Overview

swkom-paperless is a web application that allows users to manage their documents digitally. The frontend is built with Angular and can be found at github.com/paperless-ngx/paperless-ngx.git, while the backend is a Spring Boot application. The application can be started using Docker Compose.

Architecture

Prerequisites

• Docker
• Docker Compose
• Java 17 and Maven for building the jar files (this will be automated by Docker in the future)

Getting Started

To run the application, you will need to have Docker and Docker Compose installed on your machine. Once you have those installed, follow these steps:

1. Clone the repository: git clone https://github.com/lorenzdoe/swkom-paperless.git
2. Navigate to the project directory: cd swkom-paperless
3. Build jar files for the backend and ocr service
   • cd backend
   • mvn clean package
   • cd ../ocr
   • mvn clean package
   • cd ..
4. Start the application: docker-compose up
5. Open your web browser and navigate to http://localhost:8001

Features

• Document upload and management
• Document search and filtering
• Document sharing with other users

Authors

This project was created by Ana Matic, Amelie Boehme and Lorenz Doellinger.

License

This project is licensed under the MIT License. See the LICENSE file for details.