mirror of
https://github.com/filecoin-project/slate.git
synced 2024-12-25 01:52:45 +03:00
WIP - We're building the place you go to discover, share, and sell files on the web.
distributed-file-storageelectronfile-sharingfile-uploadfilecoinipfsnextjsreactslatestarred-filecoin-project-repostarred-repo
.github/ISSUE_TEMPLATE | ||
build | ||
common | ||
components | ||
dist | ||
electron | ||
node_common | ||
pages | ||
public/static | ||
scenes | ||
scripts | ||
vendor | ||
.babelrc | ||
.gitignore | ||
index.js | ||
nodemon.json | ||
package.json | ||
README.md | ||
rollup.config.js | ||
server.js |
Slate (WIP)
- (WIP) Cross platform OSS.
- (WIP) Amazon S3 replacement.
- (WIP) Aims to have every feature the Filecoin Network supports.
- (WIP) Great for storing images and sharing high resolution photos with friends.
- Design system -> Release repository.
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, runxcode-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 -e TEXLOTUSDEVNET_SPEED=1500 textile/lotus-devnet
. - Clone Powergate.
- Follow the instructions and run the commands in the README.md file:
cd docker
make localnet
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
Run electron (MacOS)
While you have npm run dev
running, in another terminal screen run:
rm -rf .next
npm run build-electron
npm run electron-pack
And then open Slate.app in dist/mac/slate.app
.
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. Runnpm run dev
again. - Note — If you want to clear all your local files, run
npm run dev --reset-data
. - Note — There will be new commands in the future for different contexts, like
electron
.
Get involved.
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