DistriFS

DistriFS: A Platform and User Agnostic Approach to Dataset Distribution - Published in JOSS (2024)

https://github.com/jibsil/distrifs

Science Score: 100.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 2 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: arxiv.org, joss.theoj.org
  • Committers with academic emails
    1 of 2 committers (50.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software
Last synced: 6 months ago · JSON representation ·

Repository

Distributed, efficient and secure filesystem coded in Go

Basic Info
  • Host: GitHub
  • Owner: JIBSIL
  • License: mit
  • Language: Go
  • Default Branch: main
  • Size: 167 KB
Statistics
  • Stars: 6
  • Watchers: 1
  • Forks: 0
  • Open Issues: 6
  • Releases: 1
Created about 2 years ago · Last pushed over 1 year ago
Metadata Files
Readme License Code of conduct Citation

README.md

DistriFS: efficient, secure, decentralized filesystem

status

DistriFS is a filesystem allowing for decentralized access to files of your choice through a file network. It is comparable to torrenting, IPFS and Storj. An indexer-server approach is used for security and speed. You may learn more about precisely how the software works in the "Academic Paper" section or by reading the respective README.md files in the sub-folders.

Running a Node

Participating in the DistriFS network is easy! Releases are built every minor version in Github Releases for Windows, macOS and Linux. Configure and run a server, then register it on the official indexer to start. If you want to run your own indexer, those programs are also available.

More information is available in the server folder's README.md

Academic Paper

This work is part of academic research titled "DistriFS: A Platform and User Agnostic Approach to Dataset Distribution". It is posted on arXiv is published in the Journal of Open Source Software

Contributing

Pull requests are always open, for both bugfixes and new features! Feedback and bug reports are also open via GitHub Issues - please remember to adhere to our Code of Conduct in Issues. For support, please contact me through the contacts in my bio.

Testing

Unit tests are present for every route on the server and indexer as of commit 63b61d4. You can run the tests by using the command go test ./... in the server and indexer folders to test each component.

License

DistriFS is a free-to-use academic work. It is licensed under the MIT license and is free to use in any project, commercial or noncommerical.

Owner

  • Login: JIBSIL
  • Kind: user

JOSS Publication

DistriFS: A Platform and User Agnostic Approach to Dataset Distribution
Published
July 02, 2024
Volume 9, Issue 99, Page 6625
Authors
Julian Boesch ORCID
Independent Researcher, United States
Editor
AHM Mahfuzur Rahman ORCID
Tags
Distributed file system File distribution Dataset distribution

Citation (CITATION.cff)

cff-version: "1.2.0"
authors:
- family-names: Boesch
  given-names: Julian
  orcid: "https://orcid.org/0009-0006-8945-0092"
doi: 10.6084/m9.figshare.26049448
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Boesch
    given-names: Julian
    orcid: "https://orcid.org/0009-0006-8945-0092"
  date-published: 2024-07-02
  doi: 10.21105/joss.06625
  issn: 2475-9066
  issue: 99
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 6625
  title: "DistriFS: A Platform and User Agnostic Approach to Dataset
    Distribution"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.06625"
  volume: 9
title: "DistriFS: A Platform and User Agnostic Approach to Dataset
  Distribution"

GitHub Events

Total
Last Year

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 22
  • Total Committers: 2
  • Avg Commits per committer: 11.0
  • Development Distribution Score (DDS): 0.136
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
JIBSIL 4****L 19
Daniel S. Katz d****z@i****g 3
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 1
  • Total pull requests: 8
  • Average time to close issues: 4 months
  • Average time to close pull requests: 1 day
  • Total issue authors: 1
  • Total pull request authors: 2
  • Average comments per issue: 7.0
  • Average comments per pull request: 0.13
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 6
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • suriya-ganesh (1)
Pull Request Authors
  • dependabot[bot] (10)
  • danielskatz (4)
Top Labels
Issue Labels
Pull Request Labels
dependencies (10)

Dependencies

.github/workflows/draft-pdf.yml actions
  • actions/checkout v4 composite
  • actions/upload-artifact v1 composite
  • openjournals/openjournals-draft-action master composite
indexer/go.mod go
  • github.com/bytedance/sonic v1.10.1
  • github.com/cespare/xxhash/v2 v2.2.0
  • github.com/chenzhuoyu/base64x v0.0.0-20230717121745-296ad89f973d
  • github.com/chenzhuoyu/iasm v0.9.0
  • github.com/dgraph-io/badger/v4 v4.2.0
  • github.com/dgraph-io/ristretto v0.1.1
  • github.com/dustin/go-humanize v1.0.1
  • github.com/fsnotify/fsnotify v1.7.0
  • github.com/gabriel-vasile/mimetype v1.4.2
  • github.com/gin-contrib/sse v0.1.0
  • github.com/gin-gonic/gin v1.9.1
  • github.com/go-playground/locales v0.14.1
  • github.com/go-playground/universal-translator v0.18.1
  • github.com/go-playground/validator/v10 v10.15.3
  • github.com/goccy/go-json v0.10.2
  • github.com/gogo/protobuf v1.3.2
  • github.com/golang/glog v1.1.2
  • github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da
  • github.com/golang/protobuf v1.5.3
  • github.com/golang/snappy v0.0.4
  • github.com/google/flatbuffers v23.5.26+incompatible
  • github.com/hashicorp/hcl v1.0.0
  • github.com/json-iterator/go v1.1.12
  • github.com/klauspost/compress v1.17.0
  • github.com/klauspost/cpuid/v2 v2.2.5
  • github.com/leodido/go-urn v1.2.4
  • github.com/magiconair/properties v1.8.7
  • github.com/mattn/go-isatty v0.0.19
  • github.com/mitchellh/colorstring v0.0.0-20190213212951-d06e56a500db
  • github.com/mitchellh/mapstructure v1.5.0
  • github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd
  • github.com/modern-go/reflect2 v1.0.2
  • github.com/pelletier/go-toml/v2 v2.1.0
  • github.com/pkg/errors v0.9.1
  • github.com/rogpeppe/go-internal v1.11.0
  • github.com/sagikazarmark/locafero v0.4.0
  • github.com/sagikazarmark/slog-shim v0.1.0
  • github.com/sourcegraph/conc v0.3.0
  • github.com/spf13/afero v1.11.0
  • github.com/spf13/cast v1.6.0
  • github.com/spf13/pflag v1.0.5
  • github.com/spf13/viper v1.18.2
  • github.com/subosito/gotenv v1.6.0
  • github.com/twitchyliquid64/golang-asm v0.15.1
  • github.com/ugorji/go/codec v1.2.11
  • go.opencensus.io v0.24.0
  • go.uber.org/atomic v1.9.0
  • go.uber.org/multierr v1.9.0
  • golang.org/x/arch v0.5.0
  • golang.org/x/crypto v0.16.0
  • golang.org/x/exp v0.0.0-20230905200255-921286631fa9
  • golang.org/x/net v0.19.0
  • golang.org/x/sys v0.15.0
  • golang.org/x/text v0.14.0
  • google.golang.org/protobuf v1.31.0
  • gopkg.in/ini.v1 v1.67.0
  • gopkg.in/yaml.v3 v3.0.1
indexer/go.sum go
  • 199 dependencies
server/go.mod go
  • github.com/bytedance/sonic v1.9.1
  • github.com/cespare/xxhash/v2 v2.2.0
  • github.com/chenzhuoyu/base64x v0.0.0-20221115062448-fe3a3abad311
  • github.com/dgraph-io/badger/v4 v4.2.0
  • github.com/dgraph-io/ristretto v0.1.1
  • github.com/dustin/go-humanize v1.0.0
  • github.com/fsnotify/fsnotify v1.7.0
  • github.com/gabriel-vasile/mimetype v1.4.2
  • github.com/gin-contrib/sse v0.1.0
  • github.com/gin-gonic/gin v1.9.1
  • github.com/go-playground/locales v0.14.1
  • github.com/go-playground/universal-translator v0.18.1
  • github.com/go-playground/validator/v10 v10.14.0
  • github.com/goccy/go-json v0.10.2
  • github.com/gogo/protobuf v1.3.2
  • github.com/golang/glog v1.0.0
  • github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da
  • github.com/golang/protobuf v1.5.3
  • github.com/golang/snappy v0.0.3
  • github.com/google/flatbuffers v1.12.1
  • github.com/google/uuid v1.4.0
  • github.com/hashicorp/hcl v1.0.0
  • github.com/json-iterator/go v1.1.12
  • github.com/klauspost/compress v1.17.0
  • github.com/klauspost/cpuid/v2 v2.2.4
  • github.com/leodido/go-urn v1.2.4
  • github.com/magiconair/properties v1.8.7
  • github.com/mattn/go-isatty v0.0.19
  • github.com/mitchellh/colorstring v0.0.0-20190213212951-d06e56a500db
  • github.com/mitchellh/mapstructure v1.5.0
  • github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd
  • github.com/modern-go/reflect2 v1.0.2
  • github.com/pelletier/go-toml/v2 v2.1.0
  • github.com/pkg/errors v0.9.1
  • github.com/sagikazarmark/locafero v0.4.0
  • github.com/sagikazarmark/slog-shim v0.1.0
  • github.com/sourcegraph/conc v0.3.0
  • github.com/spf13/afero v1.11.0
  • github.com/spf13/cast v1.6.0
  • github.com/spf13/pflag v1.0.5
  • github.com/spf13/viper v1.18.2
  • github.com/subosito/gotenv v1.6.0
  • github.com/twitchyliquid64/golang-asm v0.15.1
  • github.com/ugorji/go/codec v1.2.11
  • go.opencensus.io v0.24.0
  • go.uber.org/atomic v1.9.0
  • go.uber.org/multierr v1.9.0
  • golang.org/x/arch v0.3.0
  • golang.org/x/crypto v0.16.0
  • golang.org/x/exp v0.0.0-20230905200255-921286631fa9
  • golang.org/x/net v0.19.0
  • golang.org/x/sys v0.15.0
  • golang.org/x/text v0.14.0
  • google.golang.org/protobuf v1.31.0
  • gopkg.in/ini.v1 v1.67.0
  • gopkg.in/yaml.v3 v3.0.1
server/go.sum go
  • 194 dependencies