slate/README.md

Slate (WIP)

• (WIP) A wonderful experience for creating mood boards, hosting assets, and making connections between topics you are researching
• (WIP) With a Developer API and API Keys, a replacement for Amazon S3.
• (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 (July 22nd, 2020)

Current prototype (June 15th, 2020)

Developer Introduction

• To work on Slate you must have an internet connection.
• We don't have windows support at the moment.

.env

• You must create a .env file if you want to work on the service.
• You don't need one if you work on the system.

POSTGRES_ADMIN_PASSWORD=XXX
POSTGRES_ADMIN_USERNAME=XXX
POSTGRES_HOSTNAME=XXX
POSTGRES_DATABASE=XXX
JWT_SECRET=XXX
LOCAL_PASSWORD_SECRET=XXX
TEXTILE_HUB_KEY=XXX
TEXTILE_HUB_SECRET=XXX

Install and run

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

# Run using existing .data folder
npm run dev

• Visit localhost:1337 in a browser.

BROKEN: Run electron (MacOS)

@jimmylee broke the current version of the client.

rm -rf .next
npm run build-electron
npm run electron-pack

Open Slate.app in dist/mac/slate.app.

Get involved.

Do you want to...

• Help us build a design system for everyone to use?
• Help us build examples?
• Get mentorship and help with learning how to do front-end code?

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