{"id":13910955,"url":"https://github.com/Kruemmelspalter/FileSpider","last_synced_at":"2025-07-18T10:32:01.477Z","repository":{"id":61923238,"uuid":"545045117","full_name":"Kruemmelspalter/FileSpider","owner":"Kruemmelspalter","description":"FileSpider is a software for organizing and editing documents consisting of a main file and optionally different assets like images.","archived":false,"fork":false,"pushed_at":"2024-04-23T07:55:34.000Z","size":1065,"stargazers_count":1,"open_issues_count":11,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-11-25T20:39:20.700Z","etag":null,"topics":["javascript","organisation","organization","rust","sqlite","sqlx","tauri","typescript","vue","vue3","vuejs"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Kruemmelspalter.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-10-03T17:30:14.000Z","updated_at":"2024-04-23T07:55:35.000Z","dependencies_parsed_at":"2023-10-31T23:23:12.758Z","dependency_job_id":"1e1d7a02-d966-4455-ac20-30117fd10ba3","html_url":"https://github.com/Kruemmelspalter/FileSpider","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/Kruemmelspalter/FileSpider","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kruemmelspalter%2FFileSpider","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kruemmelspalter%2FFileSpider/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kruemmelspalter%2FFileSpider/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kruemmelspalter%2FFileSpider/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Kruemmelspalter","download_url":"https://codeload.github.com/Kruemmelspalter/FileSpider/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kruemmelspalter%2FFileSpider/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265742312,"owners_count":23820826,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["javascript","organisation","organization","rust","sqlite","sqlx","tauri","typescript","vue","vue3","vuejs"],"created_at":"2024-08-07T00:01:51.642Z","updated_at":"2025-07-18T10:32:01.077Z","avatar_url":"https://github.com/Kruemmelspalter.png","language":"Rust","funding_links":[],"categories":["Rust"],"sub_categories":[],"readme":"# FileSpider\n\n![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/kruemmelspalter/filespider/build.yml)\n![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/kruemmelspalter/filespider/tests.yml?label=tests)\n![GitHub](https://img.shields.io/github/license/kruemmelspalter/filespider)\n![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/kruemmelspalter/filespider)\n![GitHub release (latest SemVer including pre-releases)](https://img.shields.io/github/v/release/kruemmelspalter/filespider?include_prereleases)\n![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/kruemmelspalter/filespider)\n\nFileSpider is a software for organizing and editing documents.\nDocuments consist of a main file and optionally different assets like images.\nFor example:\n\n- a Markdown document\n- an HTML document with audio files embedded\n- a LaTeX document split into multiple other tex files and also images\n- a Xournal++ stylus note\n\nThese documents are organized via tags that can be searched for (positive and also negative filters)\nFor example:\n\n- done homework in CS about Java: `school,homework,done,cs,java` (could also be simplified to `done,cs,java` in most\n  cases but the filter before should always be correct)\n- homework that's still to do in German: `school,homework,german`\n- a notebook entry in English about literature: `notebook,english,literature,school`\n\nExample searches:\n\n- `school`: matches all documents with the tag `school` -\u003e All stuff related to school\n- `homework,cs`: matches all documents with tags `cs` and `homework` -\u003e All CS homework\n- `homework,!done`: matches all documents with the tag `homework` and without the tag `done`-\u003e All homework that still\n  needs to be done\n\nThe documents are rendered in a specified way, for example:\n\n- LaTeX files are rendered using pdflatex\n- HTML files and images are just served plainly\n- Markdown is rendered using pandoc and uses KaTeX for math\n\n## Used Technologies\n\n### Backend\n\nThe backend is written in Rust and uses the [tauri](https://tauri.app/) framework for the GUI. It uses a SQLite 3\ndatabase for storing document metadata and `sqlx` for database access. The documents are stored in a directory that\ndefaults to `~/.local/share/filespider/`. They are rendered with various renderers depending on the document type and\nbeing stored in the `.cache` directory in the document directory.\n\n### Frontend\n\nThe frontend is written in Vue.js and uses Vuetify.js for the UI components.\n\n## Supported Platforms\n\nCurrently, only Linux is supported. Windows is not supported as the hashing library is not Windows compatible, but I\nwill soon replace it and make the app Windows compatible (see #87). I'm not sure about macOS as I don't have any Mac\ndevice to test it on.\n\n## Setup\n\nLaunch the AppImage or install the deb package and launch the application.\n\n### Development Setup\n\nUse `cargo tauri dev` for an auto-reloading development server\n\n## Usage\n\n- Use the `Create Document` button to create a new document\n- If there already are documents, search for a document via entering appropriate tags or a crib (still requires at least\n  one tag) in the search bar\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FKruemmelspalter%2FFileSpider","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FKruemmelspalter%2FFileSpider","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FKruemmelspalter%2FFileSpider/lists"}