FLock.io Client

A Desktop Client to access the FLock.io platform


Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact

About The Project

This new FLock client interface boasts a state-of-the-art graphical user interface (GUI), offering a seamless and user-friendly platform for our esteemed users. The client, elegantly wrapped in Electron, enables users to effortlessly engage with FLock's diverse features and functionalities through a visually appealing and intuitive interface. These features include:

• Communicate with a smart contract on a blockchain
• Interact with IPFS for uploading and downloading model parameters
• Automatically stake of tokens based on the current threshold
• Participate in a federated learning system with a clear voting and proposing mechanism
• Flexible with any model that implements the required interface
• Handle training and evaluation of the models

You may download the desktop client of the lastest version here.

For more detailed technical explanation of the FLock client, see here.

(back to top)

Built With

• 
• 
• 
• 

(back to top)

Getting Started

Prerequisites

• node
• npm

Installation

1. Clone the repo

   git clone https://github.com/flock-io/client-interface.git

2. Install NPM packages

   npm install

   (back to top)

Usage

1. Start in developing mode

   npm start

2. Go to new app running

(back to top)

Contributing

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)

License

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

(back to top)

Contact

Rodrigo Pavezi - @rodrigopavezi - rodrigo@flock.io

Project Link: https://github.com/flock-io/client-interface

(back to top)