Skip to content

🏛️ A dashboard that provides visibility into the Filecoin market between Storage Clients and Storage Providers.

License

Notifications You must be signed in to change notification settings

filecoin-project/filecoin-storage-providers-market

Repository files navigation

Filecoin Storage Providers Market Dashboard

Status

At least of 2024-10-30, this dasbhoard is a scrappy work-in-progress to help spur discussion at FDS-5 Bangkok and shouldn't be viewed as canonical. It is being worked on actively by members of the "PMF Targets Working Group".

Purpose

The purpose of this dashboard currently is to help fascilitate the market between onramps/aggregators and Storage Providers (SPs) so onramps/aggregators can find SPs to use and SPs can understand how they are being evaluated. This is being done by by exposing SP performance against the service classes with their supporting SLOs as defined in filecoin-project/service-classes.

Dashboard URL

https://filecoin-project.github.io/filecoin-storage-providers-market/

In future, this may house under a different domain.

Contributing

If you want to help with data presentation, layout, etc. please see implementation details below and open a PR.

Discussion and improvement proposals around service classes, SLOs, SLIs, and their defitions should occur in filecoin-project/service-classes.

Implementation Details

This is an Observable Framework app. You'll need to install the DuckDB CLI and then run:

npm install

To start the local preview server, run:

npm run dev

Then visit http://localhost:3000 to preview your app.

For more, see https://observablehq.com/framework/getting-started.

Project structure

src - This is the “source root” — where your source files live. Pages go here. Each page is a Markdown file. Observable Framework uses file-based routing, which means that the name of the file controls where the page is served. You can create as many pages as you like. Use folders to organize your pages.

src/index.md - This is the home page for your app. You can have as many additional pages as you’d like, but you should always have a home page, too.

src/data - You can put data loaders or static data files anywhere in your source root, but we recommend putting them here.

src/components - You can put shared JavaScript modules anywhere in your source root, but we recommend putting them here. This helps you pull code out of Markdown files and into JavaScript modules, making it easier to reuse code across pages, write tests and run linters, and even share code with vanilla web applications.

observablehq.config.js - This is the app configuration file, such as the pages and sections in the sidebar navigation, and the app’s title.

Command reference

Command Description
npm install Install or reinstall dependencies
npm run dev Start local preview server
npm run build Build your static site, generating ./dist
npm run deploy Deploy your app to Observable
npm run clean Clear the local data loader cache
npm run observable Run commands like observable help

About

🏛️ A dashboard that provides visibility into the Filecoin market between Storage Clients and Storage Providers.

Resources

License

Stars

Watchers

Forks