jusonalien / fairostooling Goto Github PK

FairOS Java-SDK

FairOS implementation in Java to easily work with you DFS Server.
Explore the docs »

Report Bug · Request Feature

[]

Swarm decentralized, peer-to-peer storage opens up new opportunities for establishing a self-sovereign cloud. It also brings about a paradigm shift on how to use such storage.Layer 2 solutions on top of Swarm, such as FairOS, make additional features available, leading towards unlocking a fairer data economy.

This Java-SDK provides an simple methods to interact with FairOS

(back to top)

• FairOS
• Java
• Maven
• WSL2

(back to top)

1. This project is not audited and should not be used in a production environment.
2. The project was build on Windows and has not been tested on any Linux distro, but it should run since the tools used are cross platform.

Follow the steps below on how to run the project.

Please install the below required software in order to run the project. (Follow link for installation guide)

• DFS-server

• JDK-11

• Maven

• WSL2

1. Clone the repo

   git clone https://github.com/IKalonji/FairOSTooling.git

2. Compile

   mvn clean install -U dependency:copy-dependencies

3. Once compiled, copy the JAR file in the target folder to the /lib folder of your project

   FairOS-Java_SDK.jar --> ./lib

4. Install Maven dependency and .jar dependency to POM.xml:

$ mvn install:install-file –Dfile=C:/dev/app.jar -DgroupId=org.javasdk.fairos -DartifactId=FairOS-Java-SDK -Dversion=1.0-SNAPSHOT

<dependency>
  <groupId>org.javasdk.fairos</groupId>
  <artifactId>FairOS-Java-SDK</artifactId>
  <version>1.0-SNAPSHOT</version>
</dependency>

6. Import and instantiate classes to call the required methods, Example:

  User user = new User();
  HashMap signedIn = user.signupUser("username", "strongpassword", "mnemonic")

  Pod pod = new Pod("cookie");
  HashMap newpod = pop.podNew("podName", "strongpassword")

  FileSystem fs = new FileSystem("cookie");
  HashMap newDir = fs.fsMakeDirectory("podName", "dirPath")

  KeyValueDB kvDB = new KeyValueDB("cookie");
  HashMap newKvStore = kvDB.newTable("podName", "tablename", "indexType")

  DocumentDB docDB = new DocumentDB("cookie");
  HashMap newDocDB = DocumentDB.createDB("podName", "tablename", "DocFieldIndex")

(back to top)

See FairOS for full list of available requests.

Please refer to the Documentation

(back to top)

• Add integration tests
• Refactor methods
• Implement Singleton pattern
• Support for Websockets

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Issa Kalonji - @ISSDawg - [email protected]

Project Link: https://github.com/IKalonji/FairOSTooling

(back to top)

• FairOS
• Gitcoin
• WAM

(back to top)