slate/README.md

Slate (WIP)

• Cross platform OSS.
• Amazon S3 replacement.
• Aims to have every feature the Filecoin Network supports.
• Great for storing images.
• Design system

Current prototype (June 15th, 2020)

Developer Introduction

Run locally (MacOS)

• DevNet and Powergate are not required if you just want to work on the design system.

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.

• Note — There might be a small delay between Powergate and Lotus.

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

Example of what to expect

• Visit localhost:1337 in the browser.
• If you see the design system page instead, that means a token was not properly generated in the .data folder. Run npm run dev again.
• 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.
• For any build questions feel free to reach out to Colin: cs.mccaleb@gmail.com