Data House is a web application designed for studying knowledge management requirements and sustaining digital transformation in complex organisations and project networks.
It can be used and customised for proof of concept (PoC), prototype or minimum viable product (MVP) development.
The following features are currently available in the Data House:
- Authorisation and user permissions
- Group users into teams and manage their access levels
- Upload documents (PDF, Word document, PowerPoint presentation, images)
- Import files from external sources via WebDAV (e.g. Nextcloud)
- Full-text search of uploaded documents
- AI-powered interactions including summarisation, question answering across single and multiple documents (coming soon)
- Extensible architecture
note The Data House is under active development. Some documentation may be missing or incomplete. If you have any further questions, please send a message to info@oneofftech.xyz.
Requires Docker, Docker Compose and a MariaDB 10.8 database.
to be documented
to be documented
Data House is built using the Laravel framework and Jetstream. Livewire is used to deliver dynamic components, while TailwindCSS powers the UI styling.
Given the selected stack and feature set the development requires:
- PHP 8.1 or above
- Composer
- NodeJS version 14 or above with Yarn package manager (tested with v1.x)
- MariaDB version 10.8 or above
- Meilisearch version 1.6 or above as the full-text search engine
- Docker
A Docker Compose file (generated using Laravel Sail) is provided to quick start the required services.
The application is covered by unit and feature tests (powered by PHPUnit). Tests runs at each push to GitHub.
You can run all the test suite by executing:
php artisan test
# or ./vendor/bin/phpunitTests execution requires a running instance of MySQL. If you use the given Docker Compose file a test database is already generated for you.
Thank you for considering contributing to the Data House! The contribution guide can be found in the CONTRIBUTING.md file.
The project is supported by OneOff-Tech (UG).
If you discover a security vulnerability within Data House, please send an e-mail to OneOff-Tech team via security@oneofftech.xyz. All security vulnerabilities will be promptly addressed.
The Data House code is licenced under the terms of the AGPL v3.
Copyright (c) 2023-Present OneOff-tech UG, Germany www.oneofftech.de