Giter Club home page Giter Club logo

pvp's Introduction

Personal Vault Project PVP1

๐Ÿ˜Œ Imagine having all your digital life, in your possession, indexed and searchable. ๐Ÿค– Now, add AI on top and be able to ask it anything about your life. Find trends, detect habits, find the bright and the dark spots. ๐Ÿงณ Your digital legacy, completely yours. All your photos, notes, posts, projects, chats, everything. โœจ This is a project I've been pondering for a while now, but actually giving it more thought now. I finally have words on paper.

See the Discussions section to ask, comment, suggest or contribute.

Table of Contents

Components:

  • /storage - ZFS tools
  • /roadrunner - Metadata extraction & processing tools
  • /database - The relational database
  • /index - (future) Indexing tools (future)
  • /llm - (future) LLM tools (future)
  • /viewer - (future) Web interface (future)

Development

# Destroy all conainers + volumes and rebuild from scratch
docker compose down -v && docker compose up --build

# Destroy all conainers and rebuild from scratch
docker compose down && docker compose up --build

# Run the scan script
docker compose exec --workdir /var/www roadrunner /bin/bash -c "php src/scan.php"

Run the tests:

docker compose exec --workdir /var/www roadrunner /bin/bash -c "vendor/bin/phpunit --testdox"

Watch and send:

fswatch -0 --event Created --event Updated --event Renamed --event Removed ./vault | xargs -0 -n 1 -I {} ./path-converter.sh {}

Licensing and Attribution

This repository is licensed under the [AGPL License].

The documentation software [Just The Docs] is licensed under MIT. A copy of the license is available in [docs/just-the-docs/LICENSE]

The deployment GitHub Actions workflow is heavily based on GitHub's mixed-party [starter workflows]. A copy of their MIT License is available in [actions/starter-workflows].


Footnotes

  1. Needs a better name, see Issue #4 [starter workflows]: https://github.com/actions/starter-workflows/blob/main/pages/jekyll.yml [actions/starter-workflows]: https://github.com/actions/starter-workflows/blob/main/LICENSE [AGPL License]: https://www.gnu.org/licenses/agpl-3.0.en.html [docs/just-the-docs/LICENSE]: docs/just-the-docs/LICENSE โ†ฉ

pvp's People

Contributors

dlucian avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

pvp's Issues

Need a better name?

PVP is maybe not the best option, so we need a better name for this project.

I am open to suggestions.

Sync vault filesystem to database table

A good first start is to craft a script that scans the vault folder and all sub-folders and lists them in a DB table, with path, mime-type, filename, checksum/hash, and row timestamps maybe. Not sure about original creation time and GPS coordinates, that would be amazing to have in the fast table.

This feature should use a queue to support a very large number of files is the most elegant way possible.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.