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

storm-scaffold

v1.7.1

Published

Project scaffold

Downloads

118

Readme

How to run this project

Installation

npm install

Run

npm start

Production run

npm run production

CI build

Production build, plus generates artefacts and SRI hash json file

npm run ci

Tests

Jest (https://jestjs.io/docs/en/api) and Puppeteer (https://pptr.dev/) are included, along with a static build accessibility test.

npm t

JS

The app uses es6 modules that are transpiled then transformed using browserify into a minified single app.js containing the core js used on every page.

Page or component-specific JS files should be loaded asynchronously as required. These files, which need to be browser-ready or UMD, should be placed in src/js/async.

Custom components that require their own build system to generate standalone modules for async import can be added to a 'src/js/custom-components' directory. The easiest way to build standalone modules that are consumed by the build is to use https://github.com/mjbp/storm-component-boilerplate.

CSS

SCSS, with a partial structure

  • abstracts
  • base/
  • components/
  • layout/
  • vendor/

All project configurations and variables are set in abstracts/_variables.scss.

HTML

Nunjucks templates, (https://mozilla.github.io/nunjucks/)

  1. Layout templates defining the overall structure of the complete HTML document.
  2. View templates, one for each page on the website, the structure of the static build site follows the structure of the views
  3. Macro templates contain functional components
  4. Partial view templates contain components

Variables can be set in yml in the head of each template.

Gulp Tasks

The key build tasks should be run via npm scripts, but the full gulp API can be read at the bottom of the gulpfile.

Add a production flag to run in production mode, and compress everything.

node node_modules/.bin/gulp start --production