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

Update README.md

Browse Source
This commit is contained in:
CAKE 2020-09-06 20:42:51 -07:00 committed by GitHub
parent bcb15a06d2
commit 77d2efbb45
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
README.md
View File

@ -1,30 +1,34 @@
![Slate](https://user-images.githubusercontent.com/310223/90989634-2048ae80-e550-11ea-938f-302a35ee1174.png)
![Slate](https://user-images.githubusercontent.com/310223/92346209-e368d580-f080-11ea-8693-0fb64f8d3b97.jpg)
# 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.
### An open source storage system for your data that makes it easy to collect, organize, and share them anywhere on the web.
- [Design System](https://slate.host/_/system)
- [Release Repository](https://github.com/filecoin-project/slate-react-system)
- [Live Application Release Candidate](https://slate.host/_)
- [Powered by Filecoin](https://filecoin.io)
- [Powered by Textile](https://textile.io)
- [Follow us on Twitter](https://twitter.com/_slate)
- [Create an account and try it out!](https://slate.host)
- [Use our components](https://slate.host/_/system)
- [Design System Release Repository](https://github.com/filecoin-project/slate-react-system)
- [Filecoin](https://filecoin.io)
- [Textile](https://textile.io)
- [Twitter](https://twitter.com/_slate)
### Introduction
![Slate Preview](https://user-images.githubusercontent.com/310223/92346093-94bb3b80-f080-11ea-8ac6-c4cce3cd1aec.gif)
Slate is the first open source file storage application designed to encourage collaboration and research across a distributed network. It is a first step towards enabling a thriving network for data storage and transactions powered by IPFS, Filecoin and Textile that is open and usable for everyone. Our goal is to provide a meaningful story for every feature the protocol provides today and in the future. The Slate Project is the byproduct of a growing community of contributors from around the world.
Slate is tightly scoped for the present and more broadly thought out for the future. Our primary objective is to create a best-in-class experience for uploading, collecting, and sharing media. Additional filetypes will be supported, but our focus is to start with the pieces that apply to everyone and then dial into more specific formats.
- Example Slate: https://slate.host/tara/loom
- Example User Profile: https://slate.host/gndclouds
- Our New Brand: https://slate.host/narative/slate-brand-identity
- Example slate: https://slate.host/tara/loom
- Example user profile: https://slate.host/gndclouds
- New brand: https://slate.host/narative/slate-brand-identity
- Monet on Filecoin: https://slate.host/slate/monet
### Developer API
Slate has a Developer API that allows you upload files using code. Every user who creates an account on Slate can use the API today. Here is an example of how simple it is:
Slate has a Developer API that allows you upload files using code and HTTP.
Every user who creates an account on Slate can use the API. Here is an example:
```js
const response = await fetch('https://slate.host/api/v1/get', {
@ -36,19 +40,19 @@ const response = await fetch('https://slate.host/api/v1/get', {
});
```
Create an account today and let us know what you think!
[Create an account and try it out!](https://slate.host/_)
# Get involved.
# Get involved
Slate is built by a growing community of collaborators and contributors. We’d love for you to join us!
Getting involved is simple:
How?
- Find something cool you to work on and [file an issue](https://github.com/filecoin-project/slate/issues)
- 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](https://www.twitter.com/_slate)
- Find something you want to work on and [file an issue](https://github.com/filecoin-project/slate/issues).
- If you see something you want to fix or change, **submit a PR**.
- Reach out at any time. We're always available on Twitter to answer your questions: [@\_slate](https://www.twitter.com/_slate).
## Developer Introduction
## Slate Development Guide
- To work on Slate you must have an internet connection.
- We don't have windows support at the moment.
@ -85,9 +89,3 @@ npm run dev
![screenshot](https://user-images.githubusercontent.com/310223/84878302-7d028700-b03e-11ea-82c4-c53dca9d7e65.png)
- Visit `localhost:1337` in a browser.
### Run electron (MacOS)
```sh
npm run electron-dev
```