filecoin-project/slate
1
1
Fork 0
mirror of https://github.com/filecoin-project/slate.git synced 2024-11-22 21:45:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

readme: small update

Browse Source
This commit is contained in:
jimmylee 2020-07-02 04:04:03 -07:00
parent 9d9ac2b9fe
commit 2c3ad6598d
1 changed files with 16 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
README.md
View File

@ -1,10 +1,10 @@
# Slate
# Slate (WIP)
Slate is a way to share Filecoin and Files with friends.
#### High fidelity concept (May 23rd, 2020)
![original_5ab368196245f0603c2a0c20b63c0339](https://user-images.githubusercontent.com/310223/84869134-8128a780-b032-11ea-9c4f-7b28f0870feb.png)
- Cross platform OSS.
- Amazon S3 replacement.
- Aims to have every feature the Filecoin Network supports.
- Great for storing images.
- [Design system](https://slate.host/system)
#### Current prototype (June 15th, 2020)
@ -12,45 +12,23 @@ Slate is a way to share Filecoin and Files with friends.
## Developer Introduction
We are building this product out in the open. As a developer you are welcome to take everything and anything. You are also welcome to contribute however you please.
### Run locally (MacOS)
This is an example of how to use the [Filecoin Network](https://filecoin.io) on a [Lotus DevNet](https://lotu.sh). It uses
[Textile's Powergate](https://github.com/textileio/powergate/) and [Aaron Sutula](https://github.com/asutula)'s work with the [JavaScript/TypeScript Powergate Client](https://github.com/textileio/js-powergate-client).
- DevNet and Powergate are not required if you just want to work on the [design system](https://slate.host/system).
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](https://filecoin.onrender.com/system).
- A [kitchen sink example](https://github.com/filecoin-project/slate/blob/master/server.js) for most JavaScript Powergate calls using `async` and `await`. If you need to see all of the possible functions, [look here](https://github.com/textileio/js-powergate-client/blob/master/src/ffs/index.ts).
- An example of using [Inter](https://rsms.me/inter/).
Coming soon:
- **Many more features**.
- Electron wrapper and binaries.
# Run locally (MacOS)
These steps will guide you through running the client. Having a running DevNet and Powergate instance are not required to work on the design system.
## Satisfy dependency requirements
#### Satisfy dependency requirements
- Make sure you have [homebrew](https://brew.sh/).
- 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
#### Setup Docker
- `brew install docker`.
- Install [Docker for Desktop](https://www.docker.com/products/docker-desktop) if you are running MacOS.
## Setup Lotus DevNet and Powergate
#### Setup Lotus DevNet and Powergate
- Clone the [Lotus DevNet](https://github.com/textileio/lotus-devnet) repository.
- Run `docker run --name texdevnet -e TEXLOTUSDEVNESPEED=1500 -p 1234:7777 textile/lotus-devnet`.
@ -62,9 +40,11 @@ cd docker
make devnet
```
## Install and run
### Install and run
Run these commands to start the client locally. You may need to wait a small period of time for both of the Docker instances to complete running first.
Run these commands to start the client locally.
- **Note** — There might be a small delay between Powergate and Lotus.
```sh
git clone git@github.com:filecoin-project/slate.git
@ -73,7 +53,7 @@ npm install
npm run dev
```
#### Example of what to expect
### Example of what to expect
![screenshot](https://user-images.githubusercontent.com/310223/84878302-7d028700-b03e-11ea-82c4-c53dca9d7e65.png)