Giter VIP home page Giter VIP logo

file-storage's Introduction

File Storage Module

Small zome to create and retrieve files, in holochain RSM.

This module is designed to be included in other DNAs, assuming as little as possible from those. It is packaged as a holochain zome, and an npm package that offers native Web Components that can be used across browsers and frameworks.

Please note that this module is in its early development

Documentation

  • Storybook for elements documentation.
  • Here for documentation about the FileStorageService.

Assumptions

  • You have only one DNA in which you want to store the files in your happ (this will be changed in the future).

Installation and usage

Including the zome in your DNA

  1. Create a new folder in the zomes of the consuming DNA, with the name file_storage.
  2. Add a new Cargo.toml in that folder. In its content, paste the Cargo.toml content from any zome.
  3. Change the name properties of the Cargo.toml file to file_storage.
  4. Add this zome as a dependency in the Cargo.toml file:
[dependencies]
file_storage = {git = "https://github.com/holochain-open-dev/file-storage-module", package = "file_storage"}
  • If you want to give the zome a different name you should also initialize the FileStorageService with it.
  1. Create a src folder besides the Cargo.toml with this content:
extern crate file_storage;
  1. Add the zome into your *.dna.workdir/dna.json file.
  2. Compile the DNA with the usual CARGO_TARGET=target cargo build --release --target wasm32-unknown-unknown.

Installing the UI module

npm install git://github.com/holochain-open-dev/file-storage.git#ui-build

Done! You can already use all the elements of this library. See our storybook for documentation on those.

Developer setup

Visit the developer setup.

file-storage's People

Contributors

guillemcordoba avatar hedayatabedijoo avatar

Watchers

James Cloos avatar

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.