Giter Site home page Giter Site logo

c3333 / ipld-explorer Goto Github PK

View Code? Open in Web Editor NEW

This project forked from ipld/explore.ipld.io

0.0 1.0 0.0 13.31 MB

Explore the Merkle Forest from the comfort of your browser

Home Page: https://explore.ipld.io

License: MIT License

JavaScript 93.03% HTML 6.97%

ipld-explorer's Introduction

IPLD Explorer

Explore the Merkle Forest from the comfort of your browser.

Screenshot of the IPLD explorer

Build Status dependencies Status

Background

The app accesses a local IPFS daemon via window.ipfs-fallback. It will use the window.ipfs api provided by the IPFS Companion web-extension where available, and fallback to using js-ipfs-api

The app is built with create-react-app. Please read the docs.

Install

With node > 10 (but < 12) and npm @ 6+ installed, run

npm install

Usage

When developing you can run the dev server, the unit tests, and the storybook component viewer and see the results of your changes as you save files.

In separate shells run the following:

# Run the unit tests
npm test
# Run the dev server @ http://localhost:3000
npm start
# Run the UI component viewer @ http://localhost:9009
npm run storybook

Build

To create an optimized static build of the app, output to the build directory:

# Build out the html, css & jss to ./build
npm run build

Analyze

To inspect the built bundle for bundled modules and their size, first build the app then:

# Run bundle
npm run analyze

Test

The following command will run the app tests, watch source files and re-run the tests when changes are made:

npm test

The uses Jest to run the isolated unit tests. Unit test files are located next to the component they test and have the same file name, but with the extension .test.js

Linting

The following command will perform standard linting on the code:

npm run lint

Coverage

To do a single run of the tests and generate a coverage report, run the following:

npm run test:coverage

Translations

The translations are stored on ./public/locales and the English version is the source of truth. We use Transifex to help us translate WebUI to another languages.

If you're interested in contributing a translation, go to our page on Transifex, create an account, pick a language and start translating.

You can read more on how we use Transifex and i18next in this app at https://github.com/ipfs-shipyard/ipfs-webui/blob/master/docs/LOCALIZATION.md

Contribute

Feel free to dive in! Open an issue or submit PRs.

To contribute to IPFS in general, see the contributing guide.

License

MIT © Protocol Labs

ipld-explorer's People

Contributors

dignifiedquire avatar olizilla avatar mappum avatar jbenet avatar hacdias avatar alanshaw avatar greenkeeperio-bot avatar krl avatar strml avatar travisperson avatar daviddias avatar lidel avatar fsdiogo avatar jessicaschilling avatar grassias avatar richardlitt avatar digital-dreamer avatar 59023g avatar infinisil avatar atinux avatar victorb avatar drathir avatar luigiplr avatar harlantwood avatar caioalonso avatar harveyqiu avatar tsudoko avatar jirayudech avatar jestersimpps avatar chevdor avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.