filecoin-project/slate
1
1
Fork 0
mirror of https://github.com/filecoin-project/slate.git synced 2024-12-28 11:32:46 +03:00
Code Issues Packages Projects Releases Wiki Activity
WIP - We're building the place you go to discover, share, and sell files on the web.
83 Commits 102 Branches 0 Tags 90 MiB
JavaScript 100%
110353957b
Go to file
Jim 110353957b
Merge pull request #45 from filecoin-project/@jasonleyser/component-usage-update 
Updated components usage section
2020-07-03 22:37:17 -07:00
.github/ISSUE_TEMPLATE issues: removes excess template. 2020-06-22 14:32:39 -07:00
common Navigation: renames fixtures to navigation data 2020-07-02 03:54:33 -07:00
components line-charts: removes demo page to fix the build 2020-07-02 02:49:20 -07:00
dist slate-react-system: update 2020-07-02 02:40:29 -07:00
node_common client: simulates successful case a little bit better 2020-07-02 01:59:50 -07:00
pages Component handle fix 2020-07-03 22:34:20 -07:00
public/static readme: removes logo and brand portion, adds a description for Slate 2020-06-30 17:29:29 -07:00
scenes Navigation: renames fixtures to navigation data 2020-07-02 03:54:33 -07:00
scripts cleanup: formatting pass 2020-06-18 20:57:57 -07:00
vendor initial commit for the application prototype 2020-06-03 09:20:54 -07:00
.babelrc initial commit for the application prototype 2020-06-03 09:20:54 -07:00
.gitignore Update install instructions 2020-07-02 12:15:37 -05:00
index.js cleanup: formatting pass 2020-06-18 20:57:57 -07:00
nodemon.json initial commit for the application prototype 2020-06-03 09:20:54 -07:00
package.json design system: changes build command 2020-07-02 01:32:24 -07:00
README.md fix: typo 'involed' in readme 2020-07-04 00:32:26 +00:00
rollup.config.js design system: minifies bundle, builds two target directories 2020-07-02 01:10:13 -07:00
server.js Navigation: renames fixtures to navigation data 2020-07-02 03:54:33 -07:00

README.md

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)

screenshot

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

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 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

Example of what to expect

screenshot

  • 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 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