Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/holochain-open-dev/file-storage
File Storage zome and UI module to store files in a holochain DHT
https://github.com/holochain-open-dev/file-storage
file-storage holochain module zome
Last synced: 2 months ago
JSON representation
File Storage zome and UI module to store files in a holochain DHT
- Host: GitHub
- URL: https://github.com/holochain-open-dev/file-storage
- Owner: holochain-open-dev
- License: mit
- Created: 2020-10-05T16:34:09.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-07T14:51:49.000Z (4 months ago)
- Last Synced: 2024-10-31T19:09:51.632Z (3 months ago)
- Topics: file-storage, holochain, module, zome
- Language: TypeScript
- Homepage: https://holochain-open-dev.github.io/file-storage
- Size: 86 MB
- Stars: 35
- Watchers: 6
- Forks: 4
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-weave - holochain-open-dev/file-storage
- awesome-weave - holochain-open-dev/file-storage
README
# 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`](https://holochain-open-dev.github.io/file-storage) for elements documentation.
- [Here](/ui/docs/classes/filestorageservice.md) 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:
```toml
[dependencies]
hc_zome_file_storage = {git = "https://github.com/holochain-open-dev/file-storage", package = "hc_zome_file_storage"}
```
1. Create a `src` folder besides the `Cargo.toml` with this content:
```rust
extern crate hc_zome_file_storage;
```
1. Add the zome into your `dna.yaml` file, with the name `file_storage`.
- If you want to give the zome a different name you should also initialize the `FileStorageService` with it.
2. Compile the DNA with the usual `CARGO_TARGET=target cargo build --release --target wasm32-unknown-unknown`.
### Installing the UI module
1. Install the module with `npm install "https://github.com/holochain-open-dev/file-storage#ui-build"`.
2. Import and define the the elements you want to include:
```js
import { AppWebsocket } from "@holochain/conductor-api";
import { ContextProvider } from "@holochain-open-dev/context";
import {
UploadFiles,
fileStorageServiceContext,
FileStorageService,
} from "@holochain-open-dev/file-storage";
import { css, html, LitElement } from "lit";
import { ScopedElementsMixin } from "@open-wc/scoped-elements";
import { ContextProvider } from "@holochain-open-dev/context";
import { AppWebsocket } from "@holochain/conductor-api";
customElements.define(
"file-storage-demo",
class extends ScopedElementsMixin(LitElement) {
async firstUpdated() {
const appWebsocket = await AppWebsocket.connect("ws://localhost:8888");
const appInfo = await appWebsocket.appInfo({
installed_app_id: "test-app",
});
const cellId = appInfo.cell_data[0].cell_id;
const service = new FileStorageService(appWebsocket, cellId);
new ContextProvider(this, fileStorageServiceContext, service);
}
render() {
return html``;
}
static get scopedElements() {
return {
"upload-files": UploadFiles,
};
}
}
);
```
3. Include the elements in your html:
```html
```
Take into account that at this point the elements already expect a holochain conductor running at `ws://localhost:8888`.
You can see a full working example [here](/ui/demo/index.html).
## Developer setup
Visit the [developer setup](/SETUP.md).