npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

nyats-server

v0.2.0

Published

nyats (Not Yet Another Thumbnail Service) client-side caching IPFS thumbnailing server. Generates thumbnails for IPFS CID's, writes thumbnails to IPFS, adds them to MFS, publishes IPNS hash and returns redirect to thumbnail in MFS, allowing for efficient

Downloads

51

Readme

nyats-server

nyats (Not Yet Another Thumbnail Service) client-side caching IPFS thumbnailing server. Generates thumbnails for IPFS CID's, writes thumbnails to IPFS, adds them to MFS, publishes IPNS hash and returns redirect to thumbnail in MFS, allowing for efficient client-side caching.

Client library

For usage in JS/TS, there's nyats-client, the official client library.

Dependencies

You need a local ipfs node; see: https://docs.ipfs.io/how-to/command-line-quick-start/

Usage

  1. Install dependencies: npm install
  2. Start local IPFS node: ipfs daemon
  3. npm start Or, to use the local gateway: IPFS_GATEWAY=http://127.0.0.1:8080 npm start
  4. Open http://localhost:9614/thumbnail/<protocol>/<cid>/<width>/<height>, and behold. Example: http://localhost:9614/thumbnail/ipfs/QmcRD4wkPPi6dig81r5sLj9Zm1gDCL4zgpEj9CfuRrGbzF/200/200

Development

For development, we recommend using npm run start:watch, which will watch the code and automatically rebuild and restart the server (using nodemon and ts-node).

Example with debugging, a single process and local IPFS gateway:

$ DEBUG=nyats* NYATS_PROCESSES=1 IPFS_GATEWAY=http://127.0.0.1:8080 npm run start:watch

Configuration

The main configuration options are the following, the rest can be found in src/config.ts:

  • NYATS_SERVER_HOST (default: localhost)
  • NYATS_SERVER_PORT (default: 9614)
  • IPFS_API (default: http://localhost:5001)
  • PUBLIC_IPFS_GATEWAY (default: https://dweb.link)
  • PRIVATE_IPFS_GATEWAY (default: http://127.0.0.1:8080)