slate/README.md

Filecoin Client Project (WIP)

High fidelity concept (May 23rd, 2020)

Current prototype (June 15th, 2020)

Introduction

This is an example of how to use the Filecoin Network on a Lotus DevNet. It uses Textile's Powergate and Aaron Sutula's work with the JavaScript/TypeScript Powergate Client.

Also included:

• DevNet storage deals with miners.
• Local library management, you can share it with others too.
• Local powergate authentication token management.
• Image file preview.
• Send filecoin between wallet addresses, create new addresses.
• Update your default settings.
• The beginning of an open source design system.
• A kitchen sink example for most JavaScript Powergate calls using async and await. If you need to see all of the possible functions, look here.
• An example of using Inter.

Coming soon:

• Many more features.
• Electron wrapper and binaries.
• New brand! Help us decide here. Example logos are from the Logo Archive.

Run locally (Mac OS)

These steps will guide you through running the client.

Satisfy dependency requirements

• Make sure you have homebrew.
• Make sure you run xcode-select -p, if the command does not return a response, run xcode-select --install.
• Make sure you run brew install node.
• Make sure you run brew install go.

Setup Docker

• brew install docker.
• Install Docker for Desktop if you are running MacOS.

Setup Lotus DevNet and Powergate

• Clone the Lotus DevNet repository.
• Run docker run --name texdevnet -e TEXLOTUSDEVNESPEED=1500 -p 1234:7777 textile/lotus-devnet.
• Clone Powergate.
• Follow the instructions and run the commands in the README.md file:

cd docker
make devnet

Install and run

Run these commands to start the client locally.

git clone git@github.com:filecoin-project/filecoin-client.git
cd filecoin-client
npm install
npm run dev

Example of what to expect

• Visit localhost:1337 in the browser.
• Note — If you restart the server, it clears all your local files. You can disable this by modifying the code in server.js.
• Note — There will be new commands in the future for different contexts, like electron.

Get involed.

Do you want to...

• Help us build a design system for internal use?
• Help us build out this example so every partner in the ecosystem can have example code to work with?

Then...

• If you see things you want to work on, file an issue!
• If you see something you want to fix, submit a PR!
• I'm always available on Twitter to answer your questions: @wwwjim.