mirror of
https://github.com/filecoin-project/slate.git
synced 2024-11-13 12:24:03 +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 | ||
knexfile.js | ||
LICENSE-MIT | ||
nodemon.json | ||
package.json | ||
README.md | ||
rollup.config.js | ||
server.js |
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 (June 15th, 2020)
Developer Introduction
Working on Slate requires an internet connection because we are using a hosted Powergate and a hosted Postgres. That means there is no offline mode in the short term.
.env
- We use a
dotenv
file to manage sensitive values and secrets. - You must create this file to work on the application.
- You don't need to create a
.env
file if you're only working on the design system. - There will be no local data in the short term.
POSTGRES_ADMIN_PASSWORD=XXX
POSTGRES_ADMIN_USERNAME=XXX
POSTGRES_HOSTNAME=XXX
POSTGRES_DATABASE=XXX
LOCAL_AUTHENTICATION_JWT_SECRET=XXX
LOCAL_AUTHENTICATION_PASSWORD_SECRET=XXX
Install and run
Run these commands to start the client locally.
git clone git@github.com:filecoin-project/slate.git
cd slate
npm install
# Run using existing .data folder
npm run dev
# Run a clean instance of Slate
npm run dev --reset-data
- Visit
localhost:1337
in your browser. - When you run
npm run dev
for the first time. You will create a folder called.data
. This is a temporary solution before we have user accounts to keep track of your library, settings, and Powergate token. - If you run
npm run dev --reset-data
this will reset your.data
folder. This is useful if you encounter any bugs or if we switch networks.
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
.
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