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

@customcommander/project-blueprint

v1.12.0

Published

A template for managing the development lifecycle of a Node.js package

Downloads

21

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

customcommandercustomcommander

Keywords

Readme

Project Blueprint

A template for managing the development lifecycle of a Node.js package.

Why?

There are many things to think about and set up properly before you can start writing and publishing code. This template intends to give you enough of head start as starting from scratch always slows you down. If you don't know how or where to start or fear "analysis paralysis", this template could provide a handy escape hatch.

What's in the box?

This template is entirely based on my own (insignificant) opinions on how to achieve a steady, healthy and sustainable development lifecycle. Some of my decisions are documented in architecture decision records. After you generate a repository from this template you are free to make any changes you like but you'll be on your own.

A development environment 100% dockerized

The main development container provides: Node.js 14, GNU Make, Git, JQ, Google Closure Compiler and ADR Tools. For an even better developer experience there is a .devcontainer.json file to spin up the development environment with the VS Code Remote - Containers extension.

Building

Make is the build tool. We use the Google Closure Compiler for compiling and bundling your Node.js library. A browser bundle is automatically generated too. Tape is used for testing.

Release

On every push to your main branch (either main or master) a GitHub workflow will automatically publish a new version to both NPM and GitHub. The semantic-release tool automatically works out the next version by analysing your commit messages. A CHANGELOG file is automatically generated.

Pull Request

A GitHub workflow runs all your tests against all pull requests.

Documentation

We use Slate to generate API documentation from your source files. A GitHub workflow automatically deploys to gh-pages on every push to your main branch. (Example https://customcommander.github.io/project-blueprint/)

Architecture Decision Records (ADR)

Keeping a record of your architecture decisions is as important as writing and maintaining code. The development environment comes with ADR Tools.