https://github.com/fairdatasociety/fairos-connect

To be used by Dapps using Fairdrive.
https://github.com/fairdatasociety/fairos-connect

Last synced: 7 days ago
JSON representation

To be used by Dapps using Fairdrive.

• Host: GitHub
• URL: https://github.com/fairdatasociety/fairos-connect
• Owner: fairDataSociety
• License: gpl-3.0
• Created: 2021-05-03T12:12:30.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-12-19T16:18:47.000Z (almost 2 years ago)
• Last Synced: 2024-04-10T02:56:44.882Z (7 months ago)
• Language: TypeScript
• Size: 654 KB
• Stars: 1
• Watchers: 5
• Forks: 4
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# FairOS Connect - Reusable React Components

Use these components to kick start your Fairdrive App.

This is React component modal which will be used as a proxy for connecting on swarm network using FairOS and Fairdrive Protocol.

## Test package

  Run ```npm install fd-t-p```

  or ```yarn add fd-t-p```

  package is still in development and sandbox mode

## Running the repo and installing package locally

If you clone this repo, make sure to link this project to your project:

1. First inside fairdrive-protocol run `yarn`

2. After all the packages are installed run `yarn run build:package`

3. To link the package locally run `yarn link`

4. Go to your project and run this command `yarn link "fairdrive-protocol"`

5. And run this command `npm link ../../fairdrive-protocol/app/node_modules/react`

the ../../ is path to where you have cloned fairdrive-protocol repo.

# Reusable components

## Login

To use this component what you need is to add the package

`import {LoginComponent} from "fairdrive-protocol`

Add state for password(later it will be token);

Create state for password/token

`const [password, setUserPassword] = useState(null)`

``

## Upload file

To use this component what you need is to add the package

`import {UploadFileComponent} from "fairdrive-protocol`

create state for upload response which will be true if it is successful or it will record error message

``

Inside your app create file as a Blob

`const file = new Blob([data], { type: "text/plain;charset=utf-8" });`

## Load files -

Component will load all files on current pod and you can pick any file and load it

To use this component what you need is to add the package

`import {LoadFilesComponent} from "fairdrive-protocol`

Create state for files

`const [files, setFiles] = useState(null)`

``

This component will load files from pod and store it to your app state

## Show loaded files

After you loaded the files call up on this component and create state for specific file that you click on to load it in your app

`const [file, setFile] = useState(null)`

` `

## Create new Folder

To create new folder inside your storage, import CreateNewFolder component and add state for response when directory has been created

`const [folderCreated, setFolderCreated] = useState(false);`

` `

## List Pods

To get all pods from users account call upon this function. It returns array of pods associated with account

`const [pods, setPods] = useState(null);`

` `