slate/README.md

2.6 KiB
Raw Blame History

Slate

Slate

An open source storage system for your files and data that makes it easy to collect, organize, and share them anywhere on the web.

screenshot

Current prototype (July 22nd, 2020)

Our goal is to create a new kind of storage solution that encourages collaboration and research, while also building it on a completely transparent and open source foundation. Over time, we hope to grow Slate into an elegant experience for:

  • Creating mood boards, hosting data, and making connections between topics you are researching
  • Replacing S3 with a Developer API and API keys
  • Every feature supported by Filecoin
  • Storing images and sharing them with friends :)

Slate is a client for Filecoin, Powered by Textile's Powergate and Buckets.

Get involved.

Slate is built by a growing community of collaborators and contributors. If youre interested in…

  • Creating an open source design system
  • Building a dynamic component library for open source projects
  • Learning how to write front-end code

Wed love for you to join us! Getting involved is simple:

  • Find something cool you to work on and file an issue
  • If you see something you want to fix or change, submit a PR
  • Reach out to us any time. We're always available on Twitter to answer your questions: @_slate

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

screenshot

  • Visit localhost:1337 in a browser.

Run electron (MacOS)

npm run electron-dev