Saturn Network Explorer

A geospatial visualization for Saturn network stats. Live at https://explorer.saturn.tech.

Table of Contents

• Setup
• Development
• Storybook
• Testing
• Deployment
• Contribution Guidelines
• Resources
• About

Setup

This project was bootstrapped with Create React App.

Before starting, make sure you have Git and NodeJS installed. We're using asdf to manage node versions, it is recommended but not necessary.

First, clone & setup the repository:

git clone git@github.com:filecoin-saturn/explorer.git
cd explorer
asdf install
npm install

After that, open or create the .env file in your editor and fill in the required secret value for the Mapbox API.

REACT_APP_MAP_BOX_ACCESS_TOKEN=<your_secret_token>

Development

To start your development environment run:

npm start

Storybook

We use Storybook to document the project components and their usage.

To start Storybook run:

npm run storybook

Deployment

Deployments are currently automated by, and deployed to, Netlify.

For local, production builds, run

npm run build

This builds the app for production to the build/ directory. It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include hashes. The app is ready to be deployed!

Contribution Guidelines

This codebase was originally written following Subvisual's guides. For consistency, contributions should also follow this guide and its styles.

About

Saturn Network Explorer was created and is maintained with ❤️ by Subvisual.

The explorer's design work can be found here.