Giter Club home page Giter Club logo

dir-index-html's Introduction

dir-index-html

Made by Protocol Labs Project: IPFS Matrix IRC standard-readme compliant

Directory listing HTML for go-ipfs gateways

NOTE: This repo is not intended to be used as a standalone project! This code is used by the gateway code within go-ipfs. In the long term, once the the gateway is extracted from go-ipfs, the code in this repo will be merged into that gateway package.

Updating

When making updates to the directory listing page template, please note the following:

  1. Make your changes to the (human-friendly) source documents in the src directory
  2. Before testing or releasing, make sure to run the build script to update the minified version in the top-level directory:
> npm run build
  1. To get your updates into go-ipfs, you'll need to do the following:
    • Cut a new, appropriately versioned release of dir-index-html (don't forget to bump the version number in package.json)
    • Make a PR against go-ipfs following these instructions for updating the directory index

Testing

  1. Make sure you have Go installed
  2. Start the test server, which lives in its own directory:
> cd test
> go run .

This will listen on localhost:3000 and reload the template every time you refresh the page.

If you get a "no such file or directory" error upon trying go run ., make sure you ran npm run build to generate the minified artifact that the test is looking for.

Contribute

Feel free to join in. All are welcome! A good place to start is to check the issues for anything you find interesting.

This repository falls under the IPFS Code of Conduct.

Want to hack on IPFS?

License

MIT

dir-index-html's People

Contributors

hackergrrl avatar hsanjuan avatar jackloughran avatar jbenet avatar jessicaschilling avatar lidel avatar neatonk avatar noffle avatar rht avatar richardlitt avatar stebalien avatar stensonb avatar tusf avatar

Stargazers

 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.